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

Jump to bottom

fleetd telemetry doc updates #23423

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −11
Open

fleetd telemetry doc updates #23423

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
20 changes: 10 additions & 10 deletions docs/Contributing/API-for-contributors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3168,25 +3168,25 @@ Signals the Fleet server to send a webbook request with the device UUID and seri
Notifies the server about an agent error, resulting in two outcomes:

- The error gets saved in Redis and can later be accessed using `fleetctl debug archive`.
- The server consistently replies with a `500` status code, which can serve as a signal to activate an alarm through a monitoring tool.

> Note: to allow `fleetd` agents to use this endpoint, you need to set a [custom environment variable](./Configuration-for-contributors.md#fleet_enable_post_client_debug_errors)
> Note: to allow `fleetd` agents to use this endpoint, you need to set a [custom environment variable](./Configuration-for-contributors.md#fleet_enable_post_client_debug_errors). `fleetd` agents will always report vital errors to Fleet.

`POST /api/v1/fleet/device/{token}/debug/errors`

#### Parameters

| Name | Type | Description |
| --------------------- | -------- | ---------------------------------------------------------------- |
| error_source | string | Process name that error originated from ex. orbit, fleet-desktop |
| error_source_version | string | version of error_source |
| error_timestamp | datetime | Time in UTC that error occured |
| error_message | string | error message |
| error_additional_info | obj | Any additional identifiers to assist debugging |
| Name | Type | Description |
|-----------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------|
| error_source | string | Process name that error originated from ex. orbit, fleet-desktop |
| error_source_version | string | version of error_source |
| error_timestamp | datetime | Time in UTC that error occured |
| error_message | string | error message |
| error_additional_info | obj | Any additional identifiers to assist debugging |
| vital | boolean | Whether the error is vital and should also be reported to Fleet via usage statistics. Do not put sensitive information into vital errors. |

##### Default response

`Status: 500`
`Status: 200`

---

Expand Down
2 changes: 1 addition & 1 deletion docs/Contributing/Configuration-for-contributors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ license:

### FLEET_ENABLE_POST_CLIENT_DEBUG_ERRORS

Use this environment variable to allow `fleetd` to report errors to the server using the [endpoint to report an agent error](./API-for-contributors.md#report-an-agent-error).
Use this environment variable to allow `fleetd` to report errors to the server using the [endpoint to report an agent error](./API-for-contributors.md#report-an-agent-error). `fleetd` agents will always report vital errors to Fleet.

<meta name="pageOrderInSection" value="1100">
<meta name="description" value="Learn about the configuration files and settings that are helpful when developing or contributing to Fleet.">
Loading