Note
Fleet Management is currently in public preview. Grafana Labs offers limited support, and breaking changes might occur prior to the feature being made generally available.
Fleet Management APIs
This section includes reference documentation for the following APIs:
- The Collector API
Reference documentation for Grafana Fleet Management's Collector API - The Pipeline API
Reference documentation for Grafana Fleet Management's Pipeline API
API Reference
NOTE THAT THERE IS NO CONTENT AVAILABLE FOR ANY OF THE RESPONSES. ALSO I DON’T KNOW WHICH OF THESE ENTIRES SHOULD BE H2
collector.proto
Attributes
| Field | Type | Label | Description |
|---|
| values | Value | repeated | |
BulkUpdateCollectorsRequest
| Field | Type | Label | Description |
|---|
| ids | string | repeated | |
| ops | Operation | repeated | |
BulkUpdateCollectorsResponse
Collector
| Field | Type | Label | Description |
|---|
| id | string | | |
| attribute_overrides | Collector.AttributeOverridesEntry | repeated | |
| created_at | google.protobuf.Timestamp | optional | |
| updated_at | google.protobuf.Timestamp | optional | |
| name | string | | |
| attributes | Collector.AttributesEntry | repeated | |
| enabled | bool | optional | |
Collector.AttributeOverridesEntry
| Field | Type | Label | Description |
|---|
| key | string | | |
| value | string | | |
Collector.AttributesEntry
| Field | Type | Label | Description |
|---|
| key | string | | |
| value | string | | |
Collectors
| Field | Type | Label | Description |
|---|
| collectors | Collector | repeated | |
CreateCollectorRequest
| Field | Type | Label | Description |
|---|
| collector | Collector | | |
DeleteCollectorRequest
| Field | Type | Label | Description |
|---|
| id | string | | |
DeleteCollectorResponse
GetCollectorRequest
| Field | Type | Label | Description |
|---|
| id | string | | |
GetConfigRequest
GetConfigRequest is the request message to get a collector’s configuration. The collector’s ID and any supplied attributes are used to determine which pipelines to include in the configuration.
| Field | Type | Label | Description |
|---|
| id | string | | |
| metadata | GetConfigRequest.MetadataEntry | repeated | |
| attributes | GetConfigRequest.AttributesEntry | repeated | |
GetConfigRequest.AttributesEntry
| Field | Type | Label | Description |
|---|
| key | string | | |
| value | string | | |
GetConfigRequest.MetadataEntry
| Field | Type | Label | Description |
|---|
| key | string | | |
| value | string | | |
GetConfigResponse
| Field | Type | Label | Description |
|---|
| content | string | | |
ListCollectorAttributesRequest
ListCollectorAttributesResponse
| Field | Type | Label | Description |
|---|
| attributes | ListCollectorAttributesResponse.AttributesEntry | repeated | |
ListCollectorAttributesResponse.AttributesEntry
| Field | Type | Label | Description |
|---|
| key | string | | |
| value | Attributes | | |
ListCollectorsRequest
| Field | Type | Label | Description |
|---|
| matchers | string | repeated | |
Operation
| Field | Type | Label | Description |
|---|
| op | Operation.OpType | | Operation to perform |
| path | string | | Path for the operation, this is a JSON path |
| from | string | optional | Source path for move or copy operations |
| value | string | optional | Value for add and replace operations, as well as selective remove |
| oldValue | string | optional | Old value for selective replace |
RegisterCollectorRequest
| Field | Type | Label | Description |
|---|
| id | string | | |
| attributes | RegisterCollectorRequest.AttributesEntry | repeated | |
| name | string | | |
RegisterCollectorRequest.AttributesEntry
| Field | Type | Label | Description |
|---|
| key | string | | |
| value | string | | |
RegisterCollectorResponse
UnregisterCollectorRequest
| Field | Type | Label | Description |
|---|
| id | string | | |
UnregisterCollectorResponse
UpdateCollectorRequest
| Field | Type | Label | Description |
|---|
| collector | Collector | | |
Value
| Field | Type | Label | Description |
|---|
| value | string | | |
Operation.OpType
| Name | Number | Description |
|---|
| UNKNOWN | 0 | |
| ADD | 1 | |
| REMOVE | 2 | |
| REPLACE | 3 | |
| MOVE | 4 | |
| COPY | 5 | |
CollectorService
CollectorService is the service that provides remote configuration for the collector. It is used to register and update the collector’s attribute overrides, and to fetch the collector’s configuration.
| Method Name | Request Type | Response Type | Description |
|---|
| GetConfig | GetConfigRequest | GetConfigResponse | GetConfig returns the collector’s configuration. |
| RegisterCollector | RegisterCollectorRequest | RegisterCollectorResponse | RegisterCollector registers the collector with the given ID and attributes. It will update the collector’s attributes if the collector is already registered and the attributes are different. |
| UnregisterCollector | UnregisterCollectorRequest | UnregisterCollectorResponse | UnregisterCollector unregisters the collector with the given ID. |
| GetCollector | GetCollectorRequest | Collector | GetCollector returns information about the collector. |
| ListCollectors | ListCollectorsRequest | Collectors | ListCollectors returns information about all collectors. |
| CreateCollector | CreateCollectorRequest | Collector | CreateCollector registers a new collector. |
| UpdateCollector | UpdateCollectorRequest | Collector | UpdateCollector updates an existing collector. |
| BulkUpdateCollectors | BulkUpdateCollectorsRequest | BulkUpdateCollectorsResponse | BulkUpdateCollectors updates multiple collectors. |
| DeleteCollector | DeleteCollectorRequest | DeleteCollectorResponse | DeleteCollector deletes an existing collector. |
| ListCollectorAttributes | ListCollectorAttributesRequest | ListCollectorAttributesResponse | ListCollectorAttributes returns all attributes that are used for all collectors. |
pipeline.proto
CreatePipelineRequest
| Field | Type | Label | Description |
|---|
| pipeline | Pipeline | | |
| validate_only | bool | | If set, validate the request and preview the response, but don’t create the actual resource. |
DeletePipelineRequest
| Field | Type | Label | Description |
|---|
| id | string | | |
DeletePipelineResponse
GetPipelineRequest
| Field | Type | Label | Description |
|---|
| id | string | | |
ListPipelinesRequest
Pipeline
A Pipeline is a self-contained snippet of configuration that can be assigned to collectors based on matchers.
| Field | Type | Label | Description |
|---|
| name | string | | The name of the pipeline. This is the unique identifier for the pipeline. |
| contents | string | | The configuration contents of the pipeline to be used by collectors. |
| matchers | string | repeated | Matchers are used to match against collectors and assign pipelines to them. They follow the syntax of the Prometheus Alertmanager matchers |
| created_at | google.protobuf.Timestamp | optional | |
| updated_at | google.protobuf.Timestamp | optional | |
| enabled | bool | optional | Whether the pipeline is enabled for collectors. |
| id | string | optional | |
Pipelines
| Field | Type | Label | Description |
|---|
| pipelines | Pipeline | repeated | |
UpdatePipelineRequest
| Field | Type | Label | Description |
|---|
| pipeline | Pipeline | | |
| validate_only | bool | | If set, validate the request and preview the response, but don’t update the actual resource. |
UpsertPipelineRequest
| Field | Type | Label | Description |
|---|
| pipeline | Pipeline | | |
PipelineService
The PipelineService defines the RPCs for managing pipelines.
| Method Name | Request Type | Response Type | Description |
|---|
| GetPipeline | GetPipelineRequest | Pipeline | GetPipeline returns a pipeline by name. |
| ListPipelines | ListPipelinesRequest | Pipelines | ListPipelines returns all pipelines. |
| CreatePipeline | CreatePipelineRequest | Pipeline | CreatePipeline creates a new pipeline and returns it. |
| UpdatePipeline | UpdatePipelineRequest | Pipeline | UpdatePipeline updates an existing pipeline and returns it. |
| UpsertPipeline | UpsertPipelineRequest | Pipeline | UpsertPipeline creates a new pipeline or updates an existing one and returns it. |
| DeletePipeline | DeletePipelineRequest | DeletePipelineResponse | DeletePipeline deletes a pipeline by name. |
