Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] xpack.monitoring.history.duration doesn't accept month #40021

Closed
kiju98 opened this issue Mar 14, 2019 · 4 comments · Fixed by #40633
Closed

[docs] xpack.monitoring.history.duration doesn't accept month #40021

kiju98 opened this issue Mar 14, 2019 · 4 comments · Fixed by #40633
Assignees
Labels

Comments

@kiju98
Copy link

kiju98 commented Mar 14, 2019

https://www.elastic.co/guide/en/elasticsearch/reference/current/monitoring-settings.html has

xpack.monitoring.history.duration
Sets the retention duration beyond which the indices created by a Monitoring exporter are automatically deleted. Defaults to 7d (7 days).

This setting has a minimum value of 1d (1 day) to ensure that something is being monitored, and it cannot be disabled.

I tested with 1m and 1M to set it to 1 month on Elasticsearch 6.6.0 but they produced the following error:

 “org.elasticsearch.bootstrap.StartupException: java.lang.IllegalArgumentException: failed to parse value [1m] for setting [xpack.monitoring.history.duration], must be >= [24h]”

Looks like both m and M are considered as minutes and I see it accepts h and s.

I think it would be better if it is added to document that xpack.monitoring.history.duration accepts only d for days, h for hours, m and M for minutes, s for seconds but not months.

@kiju98 kiju98 added >enhancement >docs General docs changes labels Mar 14, 2019
@kiju98
Copy link
Author

kiju98 commented Mar 14, 2019

Pinging @elastic/es-docs

@kiju98 kiju98 changed the title [docs] xpack.monitoring.history.duration accepts only 'd' [docs] xpack.monitoring.history.duration doesn't allow month Mar 14, 2019
@kiju98 kiju98 changed the title [docs] xpack.monitoring.history.duration doesn't allow month [docs] xpack.monitoring.history.duration doesn't accept month Mar 14, 2019
@jasontedor
Copy link
Member

The way that we typically denote this in the docs is by linking to the TimeValue settings page which explains exactly what units are supported. That is what I think we should do here, and what I think we should do in general, to avoid repeating the same sentence over and over.

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features

@jasontedor
Copy link
Member

For anyone on the @elastic/es-core-features team that wants to pick this up, see follow-request-body.asciidoc for an example of how we denote this elsewhere in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants