{
"derived_label": {
"label_name": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"existing_label_policy": "KEEP",
"metric_label": {
"constructed_label": {
"value_definitions": [
{
"filters": [
{
"name": "job",
"value_glob": "myservice*"
}
],
"value": "<string>"
}
]
},
"mapping_label": {
"name_mappings": [
{
"filters": [
{
"name": "job",
"value_glob": "myservice*"
}
],
"source_label": "<string>",
"value_mappings": [
{
"source_value_globs": [
"<string>"
],
"target_value": "<string>"
}
]
}
],
"value_mappings": [
{
"source_value_globs": [
"<string>"
],
"target_value": "<string>"
}
]
}
},
"slug": "<string>",
"span_tag": {
"name_mappings": [
{
"source_tag": "<string>"
}
]
},
"updated_at": "2023-11-07T05:31:56Z"
}
}UpdateDerivedLabel
{
"derived_label": {
"label_name": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"existing_label_policy": "KEEP",
"metric_label": {
"constructed_label": {
"value_definitions": [
{
"filters": [
{
"name": "job",
"value_glob": "myservice*"
}
],
"value": "<string>"
}
]
},
"mapping_label": {
"name_mappings": [
{
"filters": [
{
"name": "job",
"value_glob": "myservice*"
}
],
"source_label": "<string>",
"value_mappings": [
{
"source_value_globs": [
"<string>"
],
"target_value": "<string>"
}
]
}
],
"value_mappings": [
{
"source_value_globs": [
"<string>"
],
"target_value": "<string>"
}
]
}
},
"slug": "<string>",
"span_tag": {
"name_mappings": [
{
"source_tag": "<string>"
}
]
},
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Chronosphere API token
Path Parameters
Body
If true, the DerivedLabel will be created if it does not already exist, identified by slug. If false, an error will be returned if the DerivedLabel does not already exist.
The DerivedLabel to update.
Show child attributes
Show child attributes
Name of the derived label. Must be unique across the system.
The name of the DerivedLabel. You can modify this value after the DerivedLabel is created.
Optional. Description of the derived label.
Specifies the action taken when there's a metric label with the same name as
this derived label, on the same time series. If the label is present on another
time series, this field doesn't apply. Default: KEEP.
- If set to
KEEP, the label that already exists on the metric is used instead of the derived label. - If set to
OVERRIDE, the derived label is used instead of the metric's existing label.
KEEP, OVERRIDE Sets the metric labels to map to label_name.
Show child attributes
Show child attributes
A constructed label creates a label where none previously existed, in contrast
to a mapping derived label. For example, this mapping constructs a label
that's defined only when an instance begins with
m3coordinator-{read,write,admin}, and where the value is statically
defined.
label_name: tier
constructed_label:
value_definitions:
- filters:
- name: instance
value_glob: m3coordinator-read*
value: read
- filters:
- name: instance
value_glob: m3coordinator-write*
value: write
- filters:
- name: instance
value_glob: m3coordinator-admin*
value: admin
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Determine when to apply name_mappings, filtering out all other values.
A mapping label is a type of derived label that's generated by pulling values
from some other label on the time series. For example, this mapping matches a
label that's defined only when __name__ begins with envoy_ or grpc_, and
where the value is copied from backend_service or grpc_service:
label_name: chronosphere_service
mapping_label:
name_mappings:
- filters:
- name: __name__
value_glob: grpc_*
source_label: grpc_service
- filters:
- name: __name__
value_glob: envoy_*
source_label: backend_service
Show child attributes
Show child attributes
Determines where the input data for a derived label comes from. For each
name mapping, you must define a source_label. If multiple name mappings
are defined, the first name mapping that matches is used to map the source
label to the derived label.
Show child attributes
Show child attributes
The source label name on the time series from when it was ingested.
These value mappings apply only to the name mapping they belong to.
Show child attributes
Show child attributes
Defines the source label values that map into the given target_value.
The value that source_value_globs are mapped into. For example, this
mapping indicates that the target value cat maps to the source label's
values of Cat and CAT.:
value_mappings:
- source_value_globs:
- Cat
- CAT
target_value: cat
These value mappings apply to the whole mapping label. If there's no name_mappings, these value mappings apply to the label that exists on the metric.
Show child attributes
Show child attributes
Defines the source label values that map into the given target_value.
The value that source_value_globs are mapped into. For example, this
mapping indicates that the target value cat maps to the source label's
values of Cat and CAT.:
value_mappings:
- source_value_globs:
- Cat
- CAT
target_value: cat
The unique identifier of the DerivedLabel. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the DerivedLabel is created.
Sets the span tags to map to label_name.
Show child attributes
Show child attributes
Determines where the input data for a derived label comes from. For each
name mapping, you must define a source_label. If multiple name mappings
are defined, the first name mapping that matches is used to map the source
tag to the derived tag.
Show child attributes
Show child attributes
The source span tag name.
If true, validates the specified configuration without creating or updating the DerivedLabel. If the specified configuration is valid, the endpoint returns a partial response without the DerivedLabel. If the specified configuration is invalid, the endpoint returns an error.
Response
A successful response containing the updated DerivedLabel.
Show child attributes
Show child attributes
Name of the derived label. Must be unique across the system.
The name of the DerivedLabel. You can modify this value after the DerivedLabel is created.
Timestamp of when the DerivedLabel was created. Cannot be set by clients.
Optional. Description of the derived label.
Specifies the action taken when there's a metric label with the same name as
this derived label, on the same time series. If the label is present on another
time series, this field doesn't apply. Default: KEEP.
- If set to
KEEP, the label that already exists on the metric is used instead of the derived label. - If set to
OVERRIDE, the derived label is used instead of the metric's existing label.
KEEP, OVERRIDE Sets the metric labels to map to label_name.
Show child attributes
Show child attributes
A constructed label creates a label where none previously existed, in contrast
to a mapping derived label. For example, this mapping constructs a label
that's defined only when an instance begins with
m3coordinator-{read,write,admin}, and where the value is statically
defined.
label_name: tier
constructed_label:
value_definitions:
- filters:
- name: instance
value_glob: m3coordinator-read*
value: read
- filters:
- name: instance
value_glob: m3coordinator-write*
value: write
- filters:
- name: instance
value_glob: m3coordinator-admin*
value: admin
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Determine when to apply name_mappings, filtering out all other values.
A mapping label is a type of derived label that's generated by pulling values
from some other label on the time series. For example, this mapping matches a
label that's defined only when __name__ begins with envoy_ or grpc_, and
where the value is copied from backend_service or grpc_service:
label_name: chronosphere_service
mapping_label:
name_mappings:
- filters:
- name: __name__
value_glob: grpc_*
source_label: grpc_service
- filters:
- name: __name__
value_glob: envoy_*
source_label: backend_service
Show child attributes
Show child attributes
Determines where the input data for a derived label comes from. For each
name mapping, you must define a source_label. If multiple name mappings
are defined, the first name mapping that matches is used to map the source
label to the derived label.
Show child attributes
Show child attributes
The source label name on the time series from when it was ingested.
These value mappings apply only to the name mapping they belong to.
Show child attributes
Show child attributes
Defines the source label values that map into the given target_value.
The value that source_value_globs are mapped into. For example, this
mapping indicates that the target value cat maps to the source label's
values of Cat and CAT.:
value_mappings:
- source_value_globs:
- Cat
- CAT
target_value: cat
These value mappings apply to the whole mapping label. If there's no name_mappings, these value mappings apply to the label that exists on the metric.
Show child attributes
Show child attributes
Defines the source label values that map into the given target_value.
The value that source_value_globs are mapped into. For example, this
mapping indicates that the target value cat maps to the source label's
values of Cat and CAT.:
value_mappings:
- source_value_globs:
- Cat
- CAT
target_value: cat
The unique identifier of the DerivedLabel. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the DerivedLabel is created.
Sets the span tags to map to label_name.
Show child attributes
Show child attributes
Determines where the input data for a derived label comes from. For each
name mapping, you must define a source_label. If multiple name mappings
are defined, the first name mapping that matches is used to map the source
tag to the derived tag.
Show child attributes
Show child attributes
The source span tag name.
Timestamp of when the DerivedLabel was last updated. Cannot be set by clients.