{
"log_control_config": {
"created_at": "2023-11-07T05:31:56Z",
"rules": [
{
"drop_field": {
"field_regex": "<string>",
"parent_path": {
"selector": "<string>"
}
},
"emit_metrics": {
"mode": "COUNTER",
"name": "<string>",
"counter": {
"value": {
"selector": "<string>"
}
},
"drop_log": true,
"gauge": {
"value": {
"selector": "<string>"
},
"aggregation_type": "LAST"
},
"histogram": {
"value": {
"selector": "<string>"
}
},
"labels": [
{
"key": "<string>",
"value": {
"selector": "<string>"
}
}
]
},
"filter": "<string>",
"mode": "ENABLED",
"name": "<string>",
"replace_field": {
"field": {
"selector": "<string>"
},
"replace_mode": "HASH",
"replace_regex": "<string>",
"mapped_value": {
"default_value": "<string>",
"pairs": [
{
"key": "<string>",
"value": "<string>"
}
],
"use_default": true
},
"replace_all": true,
"static_value": {
"value": "<string>"
}
},
"sample": {
"rate": 123
},
"type": "DROP"
}
],
"updated_at": "2023-11-07T05:31:56Z"
}
}ReadLogControlConfig
{
"log_control_config": {
"created_at": "2023-11-07T05:31:56Z",
"rules": [
{
"drop_field": {
"field_regex": "<string>",
"parent_path": {
"selector": "<string>"
}
},
"emit_metrics": {
"mode": "COUNTER",
"name": "<string>",
"counter": {
"value": {
"selector": "<string>"
}
},
"drop_log": true,
"gauge": {
"value": {
"selector": "<string>"
},
"aggregation_type": "LAST"
},
"histogram": {
"value": {
"selector": "<string>"
}
},
"labels": [
{
"key": "<string>",
"value": {
"selector": "<string>"
}
}
]
},
"filter": "<string>",
"mode": "ENABLED",
"name": "<string>",
"replace_field": {
"field": {
"selector": "<string>"
},
"replace_mode": "HASH",
"replace_regex": "<string>",
"mapped_value": {
"default_value": "<string>",
"pairs": [
{
"key": "<string>",
"value": "<string>"
}
],
"use_default": true
},
"replace_all": true,
"static_value": {
"value": "<string>"
}
},
"sample": {
"rate": 123
},
"type": "DROP"
}
],
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Chronosphere API token
Response
A successful response.
LogControlConfig is a singleton configuration object that specifies the configuration for log control.
Show child attributes
Show child attributes
Timestamp of when the LogControlConfig was created. Cannot be set by clients.
Control Rules are the ordered list of control rules.
Show child attributes
Show child attributes
Defines the action to drop fields from logs that match specified conditions, which helps reduce the size of individual logs. If a log contains no data after fields are dropped, you can choose to drop the entire log.
Show child attributes
Show child attributes
Defines the the regular expression that determines which fields to drop.
Optional. Specifies the level of depth in the log to apply the regular
expression to. For example, if you want to apply the regular expression to
fields under httpRequest, such as httpRequest.status, enter httpRequest
in the parent_path field. If empty, the fields to drop are at the root level
of the log.
Show child attributes
Show child attributes
The log filter used to indicate the field path. Use parent[child] syntax to
indicate nesting.
Defines the action to convert log data to metric data. Use this control rule when you want to reduce the volume of logs, retain data for a longer period, and increase the speed of querying and filtering for metrics instead of logs
Show child attributes
Show child attributes
Indicates the mode of the generated metric. Must be one of the following values:
COUNTER, GAUGE, HISTOGRAM A unique name for the generated metric. This name must conform to Prometheus naming conventions.
Generates a metric that counts the number of times a certain event has occurred.
Show child attributes
Show child attributes
Optional. Specifies the name of the log field whose value you want to use as the metric value. If unset, the counter increments by one.
Show child attributes
Show child attributes
The log filter used to indicate the field path. Use parent[child] syntax to
indicate nesting.
Optional. If true, drops the entire log after emitting the defined metric.
Generates a metric that tracks a value, which changes over time. Choose LAST
(most recent), MIN (minimum value), or MAX (maximum value) to define which
value to use.
Show child attributes
Show child attributes
The name of the log field whose value you want to use as the metric value.
Show child attributes
Show child attributes
The log filter used to indicate the field path. Use parent[child] syntax to
indicate nesting.
The aggregation type to use for the gauge. Must be one of the following values:
LAST, MIN, MAX Generates a metric that tracks the distribution of values across data groupings with exponentially increasing size.
Show child attributes
Show child attributes
The name of the log field whose value you want to use as the metric value.
Show child attributes
Show child attributes
The log filter used to indicate the field path. Use parent[child] syntax to
indicate nesting.
The labels to emit with the metric, specified as key/value pairs. The generated label is a valid Prometheus label name, mapped to a log key.
Show child attributes
Show child attributes
Log query filter to return log data for the control rule. The control action applies to only matching logs.
Specifies whether the control rule is enabled or disabled. Default: ENABLED.
ENABLED, DISABLED User-defined name of the control rule.
Defines the action to identify a specified field in your log data and uses a regular expression to replace any matches based on the selected replacement mode. Use this control rule to truncate long fields and preserve your log structure.
Show child attributes
Show child attributes
Defines the replacement mode to use in the replace rule. Must be one of the following values:
HASH, STATIC_VALUE, MAPPED_VALUE Defines the the regular expression that determines which part of the field to replace.
Defines the configuration for the mapped value replacement mode.
Show child attributes
Show child attributes
The value to use if no matching value is found.
If true, specifies a default value if no matching key is found. If
false, the value will be unchanged if no matching key is found.
Determines whether to replace all matches or just the first match.
Defines the configuration for the fixed value replacement mode.
Show child attributes
Show child attributes
The value to replace selected content with. If empty, the action removes the selected content.
Defines the action to retain a certain percentage of matching logs and drop the remainder, which can significantly reduce volume and maintain visibility.
Show child attributes
Show child attributes
Percentage of matching logs to keep. Must be in the range [0, 1], where 1
is equal to 100% of logs. For example, to keep 25% of logs, enter 0.25 as
the rate.
The type of action to take on matching logs. Must be one of the following values.
DROP, SAMPLE, DROP_FIELD, REPLACE_FIELD, EMIT_METRICS Timestamp of when the LogControlConfig was last updated. Cannot be set by clients.