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.

Sign up for GitHub

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

Clarify agent health reporting #137

Merged
merged 1 commit into from
Nov 9, 2022
Merged

Clarify agent health reporting #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions proto/opamp.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -555,16 +555,16 @@ enum AgentCapabilities {

// The health of the Agent.
message AgentHealth {
// Set to true if the Agent is up and running.
bool up = 1;
// Set to true if the Agent is up and healthy.
bool healthy = 1;

// Timestamp since the Agent is up, i.e. when the agent was started.
// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
// If "up" is false this field is unused.
// If the agent is not running MUST be set to 0.
fixed64 start_time_unix_nano = 2;

// Human-readable error message if the Agent is in erroneous state. Typically set
// when up==false.
// Human-readable error message if the Agent is in erroneous state. SHOULD be set
// when healthy==false.
string last_error = 3;
}

Expand Down
14 changes: 7 additions & 7 deletions specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Note: this document requires a simplification pass to reduce the scope, size and
- [AgentDescription.identifying_attributes](#agentdescriptionidentifying_attributes)
- [AgentDescription.non_identifying_attributes](#agentdescriptionnon_identifying_attributes)
+ [AgentHealth Message](#agenthealth-message)
- [AgentHealth.up](#agenthealthup)
- [AgentHealth.healthy](#agenthealthhealthy)
- [AgentHealth.start_time_unix_nano](#agenthealthstart_time_unix_nano)
- [AgentHealth.last_error](#agenthealthlast_error)
+ [EffectiveConfig Message](#effectiveconfig-message)
Expand Down Expand Up @@ -983,26 +983,26 @@ The AgentHealth message has the following structure:

```protobuf
message AgentHealth {
bool up = 1;
bool healthy = 1;
fixed64 start_time_unix_nano = 2;
string last_error = 3;
}
```

#### AgentHealth.up
#### AgentHealth.healthy

Set to true if the Agent is up and running.
Set to true if the Agent is up and healthy.

#### AgentHealth.start_time_unix_nano

Timestamp since the Agent is up, i.e. when the agent was started.
Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
If "up" is false this field is unused.
If the agent is not running MUST be set to 0.

#### AgentHealth.last_error

Human-readable error message if the Agent is in erroneous state. Typically set
when up==false.
Human-readable error message if the Agent is in erroneous state. SHOULD be set
when healthy==false.

### EffectiveConfig Message

Expand Down