Skip to content

[Internal]: inspect command doesn't provide enough context #3410

@blakerouse

Description

@blakerouse

Description

The inspect command here https://www.elastic.co/docs/reference/fleet/agent-command-reference#elastic-agent-inspect-command doesn't document all of the options and doesn't really explain what the command does.

The output of elastic-agent inspect --help provides a lot more context and that should really be reflected here. https://github.com/elastic/elastic-agent/blob/main/internal/pkg/agent/cmd/inspect.go#L47

This has caused confusion in the field and doesn't really help our users to understand what the inspect command does and what it should be used for.

Resources

https://github.com/elastic/elastic-agent/blob/main/internal/pkg/agent/cmd/inspect.go#L47

Which documentation set does this change impact?

Elastic On-Prem and Cloud (all)

Feature differences

Identical in all methods of deployment.

What release is this request related to?

8.17

Serverless release

Already available

Collaboration model

The documentation team

Point of contact.

Main contact: @blakerouse

Stakeholders: @elastic/elastic-agent-control-plane

Metadata

Metadata

Assignees

No one assigned

    Labels

    Team:IngestIssues owned by the Ingest Docs Team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions