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: health_report/indicator/diagnosis/affected_resources value type mismatch #106925

Open
yaauie opened this issue Mar 29, 2024 · 1 comment
Open
Labels
>bug >docs General docs changes Team:Docs Meta label for docs team

Comments

@yaauie
Copy link
Member

yaauie commented Mar 29, 2024

Elasticsearch Version

8.13.0

Installed Plugins

No response

Java Version

bundled

OS Version

NA

Problem Description

The docs claim that an indicator's diagnosis' affected_resources is an "(Optional, array of strings)":

`affected_resources`::
    (Optional, array of strings) If the root cause pertains to multiple resources in the
    cluster (like indices, shards, nodes, etc...) this will hold all resources that this
    diagnosis is applicable for.

-- docs/reference/health/health.asciidoc:206-209@v8.13.0

I am observing that the value can be an object that contains a mapping of strings to arrays-of-strings:

        {
          "id": "elasticsearch:health:shards_availability:diagnosis:increase_tier_capacity_for_allocations:tier:data_content",
          "cause": "Elasticsearch isn't allowed to allocate some shards from these indices to any of the nodes in the desired data tier because there are not enough nodes in the [data_content] tier to allocate each shard copy on a different node.",
          "action": "Increase the number of nodes in this tier or decrease the number of replica shards in the affected indices.",
          "help_url": "https://ela.st/tier-capacity",
          "affected_resources": {
            "indices": [
              "logstash-test"
            ]
          }
        }

-- GET /_health_report

I do not have enough context to know whether the shape is always a map of resource-type to list-of-resources, or if that is simply the case for the diagnosis with id elasticsearch:health:shards_availability:diagnosis:increase_tier_capacity_for_allocations:tier:data_content.

Steps to Reproduce

GET /_health_report

Logs (if relevant)

No response

@yaauie yaauie added >bug >docs General docs changes needs:triage Requires assignment of a team area label labels Mar 29, 2024
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team and removed needs:triage Requires assignment of a team area label labels Mar 29, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>bug >docs General docs changes Team:Docs Meta label for docs team
Projects
None yet
Development

No branches or pull requests

2 participants