package cproto

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Version (Empty, VersionResponse)

  control_v2.proto:369

  Fetches the currently running version of the Elastic Agent.

  message VersionResponse

  control_v2.proto:70

  Version response message.

  • string version = 1

    Current running version.

  • string commit = 2

    Current running commit.

  • string buildTime = 3

    Current running build time.

  • bool snapshot = 4

    Current running version is a snapshot.

  • bool fips = 5

    Current running version is FIPS-compliant.

• rpc State (Empty, StateResponse)

  control_v2.proto:372

  Fetches the currently states of the Elastic Agent.

• rpc StateWatch (Empty, stream StateResponse)

  control_v2.proto:378

  Streams the current state of the Elastic Agent to the client. Client will continue to get updated StateResponse when any state of the Elastic Agent has changed.

• rpc Restart (Empty, RestartResponse)

  control_v2.proto:381

  Restart restarts the current running Elastic Agent.

  message RestartResponse

  control_v2.proto:83

  • ActionStatus status = 1

    Response status.

  • string error = 2

    Error message when it fails to trigger restart.

• rpc Upgrade (UpgradeRequest, UpgradeResponse)

  control_v2.proto:384

  Upgrade starts the upgrade process of Elastic Agent.

  message UpgradeRequest

  control_v2.proto:91

  Upgrade request message.

  • string version = 1

    (Optional) Version to upgrade to. If not provided Elastic Agent will auto discover the latest version in the same major to upgrade to. If wanting to upgrade to a new major that major must be present in the this version field.

  • string sourceURI = 2

    (Optional) Use a different source URI then configured. If provided the upgrade process will use the provided sourceURI instead of the configured sourceURI in the configuration.

  • bool skipVerify = 3

    (Optional) Overrides predefined behavior for agent package verification. If provided Elastic Agent package is not checked for signature during upgrade.

  • repeated string pgpBytes = 4

    (Optional) Overrides predefined behavior for agent package verification. If provided Elastic Agent package is checked against these pgp keys as well.

  • bool skipDefaultPgp = 5

    (Optional) Overrides predefined behavior for agent package verification. If provided Elastic Agent package embedded PGP key is not checked for signature during upgrade.

  message UpgradeResponse

  control_v2.proto:122

  A upgrade response message.

  • ActionStatus status = 1

    Response status.

  • string version = 2

    Version that is being upgraded to.

  • string error = 3

    Error message when it fails to trigger upgrade.

• rpc DiagnosticAgent (DiagnosticAgentRequest, DiagnosticAgentResponse)

  control_v2.proto:387

  Gather diagnostic information for the running Elastic Agent.

  message DiagnosticAgentRequest

  control_v2.proto:287

  DiagnosticAgentRequest is request to gather diagnostic information about the Elastic Agent.

  • repeated AdditionalDiagnosticRequest additional_metrics = 1

  message DiagnosticAgentResponse

  control_v2.proto:310

  DiagnosticAgentResponse is response to gathered diagnostic information about the Elastic Agent.

  • repeated DiagnosticFileResult results = 1

    Diagnostic results for the agent.

• rpc DiagnosticUnits (DiagnosticUnitsRequest, stream DiagnosticUnitResponse)

  control_v2.proto:390

  Gather diagnostic information for the running units.

  message DiagnosticUnitsRequest

  control_v2.proto:326

  DiagnosticUnitsRequest allows a diagnostic request to specify the units to target.

  • repeated DiagnosticUnitRequest units = 1

    Specific units to target. (If no units are given then a result for all units is provided).

• rpc DiagnosticComponents (DiagnosticComponentsRequest, stream DiagnosticComponentResponse)

  control_v2.proto:393

  Gather diagnostic information for the running components.

  message DiagnosticComponentsRequest

  control_v2.proto:298

  DiagnosticComponentsRequest is the message to request diagnostics from individual components.

  • repeated DiagnosticComponentRequest components = 1

  • repeated AdditionalDiagnosticRequest additional_metrics = 2

  message DiagnosticComponentResponse

  control_v2.proto:346

  DiagnosticComponentResponse is the response diagnostic information for a component-level diagnostic request

  • string component_id = 1

    ID of the component.

  • string error = 4

    Error message for the failure fetching diagnostic information for this unit.

  • repeated DiagnosticFileResult results = 5

    Diagnostic results for the unit.

• rpc Configure (ConfigureRequest, Empty)

  control_v2.proto:401

  Configure adjusts the running Elastic Agent configuration with the configuration provided over the RPC. This is only allowed if the Elastic Agent is spawned in TESTING_MODE. Calling this on any Elastic Agent that is not in TESTING_MODE will result in an error being returned and nothing occurring.

  message ConfigureRequest

  control_v2.proto:362

  ConfigureRequest sends a new configuration for the running Elastic Agent to use.

  • string config = 1

    Config to use.

Action status codes for restart and upgrade response.

Used in: RestartResponse, UpgradeResponse

• SUCCESS = 0

  Action was successful.

• FAILURE = 1

  Action failed.

DiagnosticAgentRequestAdditional is an enum of additional diagnostic metrics that can be requested from Elastic Agent.

Used in: DiagnosticAgentRequest, DiagnosticComponentsRequest

• CPU = 0

• CONN = 1

CollectorComponent is the status of an OTel collector component.

Used in: StateResponse

• CollectorComponentStatus status = 1

  Status of the component.

• string error = 2

  Error is set to the reported error.

• string timestamp = 3

  Timestamp of status.

• map<string, CollectorComponent> ComponentStatusMap = 4

  Status information for sub-components of this component.

CollectorComponentStatus used for OTel collector components.

Used in: CollectorComponent

• StatusNone = 0

• StatusStarting = 1

• StatusOK = 2

• StatusRecoverableError = 3

• StatusPermanentError = 4

• StatusFatalError = 5

• StatusStopping = 6

• StatusStopped = 7

Current state of a running component by Elastic Agent.

Used in: StateResponse

• string id = 1

  Unique component ID.

• string name = 2

  Component name.

• State state = 3

  Current state.

• string message = 4

  Current state message.

• repeated ComponentUnitState units = 5

  Current units running in the component.

• optional ComponentVersionInfo version_info = 6

  Current version information for the running component.

Used in: ComponentState

• UnitType unit_type = 1

  Type of unit in the component.

• string unit_id = 2

  ID of the unit in the component.

• State state = 3

  Current state.

• string message = 4

  Current state message.

• string payload = 5

  Current state payload.

Version information reported by the component to Elastic Agent.

Used in: ComponentState

• string name = 1

  Name of the component.

• map<string, string> meta = 3

  2 reserved - used to be used for version of component. Extra meta information about the version.

DiagnosticComponentRequest specifies the component to send a diagnostic request to.

Used in: DiagnosticComponentsRequest

• string component_id = 1

  ID of the component.

DiagnosticFileResult is a file result from a diagnostic result.

Used in: DiagnosticAgentResponse, DiagnosticComponentResponse, DiagnosticUnitResponse

• string name = 1

  Human readable name of the diagnostic result content.

• string filename = 2

  Filename to use to store the diagnostic to the disk.

• string description = 3

  Human readable description of the information this diagnostic provides.

• string content_type = 4

  Content-Type of the resulting content.

• bytes content = 5

  Actual file content.

• optional google.protobuf.Timestamp generated = 6

  Timestamp the content was generated at.

DiagnosticUnitRequest specifies a specific unit to gather diagnostics from.

Used in: DiagnosticUnitsRequest

• string component_id = 1

  ID of the component.

• UnitType unit_type = 2

  Type of unit.

• string unit_id = 3

  ID of the unit.

DiagnosticUnitResponse is diagnostic information about a specific unit.

Used as response type in: ElasticAgentControl.DiagnosticUnits

Used as field type in: DiagnosticUnitsResponse

• string component_id = 1

  ID of the component.

• UnitType unit_type = 2

  Type of unit.

• string unit_id = 3

  ID of the unit.

• string error = 4

  Error message for the failure fetching diagnostic information for this unit.

• repeated DiagnosticFileResult results = 5

  Diagnostic results for the unit.

DiagnosticUnitsResponse is response to gathered units diagnostic information.

• repeated DiagnosticUnitResponse units = 2

  Diagnostics results per unit.

Empty message.

Used as request type in: ElasticAgentControl.Restart, ElasticAgentControl.State, ElasticAgentControl.StateWatch, ElasticAgentControl.Version

Used as response type in: ElasticAgentControl.Configure

(message has no fields)

pprof endpoint that can be requested.

• ALLOCS = 0

• BLOCK = 1

• CMDLINE = 2

• GOROUTINE = 3

• HEAP = 4

• MUTEX = 5

• PROFILE = 6

• THREADCREATE = 7

• TRACE = 8

State codes for the current state.

Used in: ComponentState, ComponentUnitState, StateResponse

• STARTING = 0

• CONFIGURING = 1

• HEALTHY = 2

• DEGRADED = 3

• FAILED = 4

• STOPPING = 5

• STOPPED = 6

• UPGRADING = 7

• ROLLBACK = 8

Used in: StateResponse

• string id = 1

  Current ID of the Agent.

• string version = 2

  Current running version.

• string commit = 3

  Current running commit.

• string buildTime = 4

  Current running build time.

• bool snapshot = 5

  Current running version is a snapshot.

• int32 pid = 6

  Current running PID.

• bool unprivileged = 7

  True when running as unprivileged.

• bool isManaged = 8

  True when agent is managed by fleet

StateResponse is the current state of Elastic Agent. Next unused id: 8

Used as response type in: ElasticAgentControl.State, ElasticAgentControl.StateWatch

• optional StateAgentInfo info = 1

  Overall information of Elastic Agent.

• State state = 2

  Overall state + message of Elastic Agent, aggregating errors in other states and components

• string message = 3

• State fleetState = 5

  Fleet state: healthy / "Connected" if the last RPC call to Fleet succeeded, otherwise failed with the associated error string.

• string fleetMessage = 6

• repeated ComponentState components = 4

  State of each component in Elastic Agent.

• optional UpgradeDetails upgrade_details = 7

  Upgrade details

• optional CollectorComponent collector = 8

  OTel collector component status information.

Unit Type running inside a component.

Used in: ComponentUnitState, DiagnosticUnitRequest, DiagnosticUnitResponse

• INPUT = 0

• OUTPUT = 1

UpgradeDetails captures the details of an ongoing Agent upgrade.

Used in: StateResponse

• string target_version = 1

  Version the Agent is being upgraded to.

• string state = 2

  Current state of the upgrade process.

• string action_id = 3

  Fleet Action ID that initiated the upgrade, if in managed mode.

• optional UpgradeDetailsMetadata metadata = 4

  Metadata about the upgrade process.

UpgradeDetailsMetadata has additional information about an Agent's ongoing upgrade.

Used in: UpgradeDetails

• string scheduled_at = 1

  If the upgrade is a scheduled upgrade, the timestamp of when the upgrade is expected to start.

• float download_percent = 2

  If the upgrade is in the UPG_DOWNLOADING state, the percentage of the Elastic Agent artifact that has already been downloaded, to serve as an indicator of download progress.

• string failed_state = 3

  If the upgrade has failed, what upgrade state failed.

• string error_msg = 4

  Any error encountered during the upgrade process.

• string retry_error_msg = 5

  Any error message that is a result of a retryable upgrade step, e.g. the download step, being retried.

• string retry_until = 6

  The deadline until when a retryable upgrade step, e.g. the download step, will be retried.