Log Monitoring metrics API - GET a metric
Gets the descriptor of the specified calculated Log Monitoring metric.
The request produces an application/json payload.
| GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/log/{metricKey} |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/log/{metricKey} | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/log/{metricKey} |
Authentication
To execute this request, you need an access token with ReadConfig scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| metricKey | string | The key of the required custom log metric. | path | required |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Log | Success |
| 400 | ErrorEnvelope | Failed. See the response body for details |
Response body objects
The LogMetricConfig object
Custom log metric definition.
| Element | Type | Description |
|---|---|---|
| metricKey | string | The unique key of the metric. The key must have the |
| active | boolean | The metric is enabled ( |
| displayName | string | The name of the metric, displayed in the UI. |
| unit | string | The unit of the metric. |
| unitDisplayName | string | The display name of the unit. Only applicable if the unit is set to |
| searchString | string | The pattern to look for in logs. Use the Dynatrace search query language to specify it. Quotes must be escaped. To return all results, leave the field blank. |
| metricValueType | string | The type of the metric data points calculation. For now the only allowed value is |
| columnDefiningValue | Column | Definition of numeric column. |
| logSourceFilters | Log | A list of filters to define the logs to look into. If several filters are specified, the OR logic applies. |
The ColumnDefinition object
Definition of numeric column.
| Element | Type | Description |
|---|---|---|
| name | string | - |
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
The LogSourceFilter object
Configuration of the log filter for a custom log metric.
If several criteria are specified, the AND logic applies.
| Element | Type | Description |
|---|---|---|
| pathDefinitions | Path | A list of filtering criteria for log path. If several criteria are specified, the OR logic applies. |
| sourceEntities | string[] | A list of Dynatrace entities, where the log can originate from. Specify Dynatrace entity IDs here. Allowed types of entities are If several entities are specified, the OR logic applies. This field is mutually exclusive with the osTypes field. |
| hostFilters | string[] | A list of hosts, where the log can originate from. Specify Dynatrace entity IDs here. If several hosts are specified, the OR logic applies. |
| osTypes | string[] | A list of operating system types, where the log can originate from. If set, only OS logs are included in the result. If several OS are specified, the OR logic applies. This field is mutually exclusive with the sourceEntities field. |
The PathDefinition object
A filtering criterion for log path.
| Element | Type | Description |
|---|---|---|
| definition | string | The path to the required log path. If the type is set to |
| type | string | The type of the log path definition: fixed or an expression with wildcards. |
Response body JSON model
{
"metricKey": "calc:log.metric",
"active": true,
"displayName": "Sample metric",
"unit": "HOUR",
"unitDisplayName": "",
"searchString": "\"memory fault\"",
"metricValueType": "OCCURRENCES",
"logSourceFilters": [
{
"pathDefinitions": [
{
"definition": "/var/log/sample.log",
"type": "FIXED"
}
],
"sourceEntities": [
"PROCESS_GROUP_INSTANCE-63FC6E7C73DC893F"
],
"hostFilters": [
"HOST-066703AD79C38DB5"
],
"osTypes": []
}
]
}Example
In this example, the request gets the definition of the Unknown parameter custom log metric.
The metric counts the occurrences of the phrase Unknown parameter in the following logs:
- All logs from the process with Dynatrace entity ID PROCESS_GROUP_INSTANCE-6CD96121AD8F5308 that runs on the host with Dynatrace entity ID HOST-5AA1203365B14DB.
- The /var/log/ansible.log from the process with Dynatrace entity ID PROCESS_GROUP_INSTANCE-7CD17F573CC3DA3F that runs on the host with Dynatrace entity ID HOST-E0D8F94D9065F24F.
The API token is passed in the Authorization header.
Curl
curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/config/v1/calculatedMetrics/log/calc:log.runknownparameter \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'Request URL
https://mySampleEnv.live.dynatrace.com/api/config/v1/calculatedMetrics/log/calc:log.runknownparameterResponse body
{
"metricKey": "calc:log.runknownparameter",
"active": true,
"displayName": "Unknown parameter",
"unit": "COUNT",
"unitDisplayName": null,
"searchString": "\"unknown parameter\"",
"metricValueType": "OCCURRENCES",
"logSourceFilters": [
{
"pathDefinitions": [],
"sourceEntities": [
"PROCESS_GROUP_INSTANCE-6CD96121AD8F5308"
],
"hostFilters": [
"HOST-5AA1203365B14DBC"
],
"osTypes": []
},
{
"pathDefinitions": [
{
"definition": "/var/log/ansible.log",
"type": "FIXED"
}
],
"sourceEntities": [
"PROCESS_GROUP_INSTANCE-7CD17F573CC3DA3F"
],
"hostFilters": [
"HOST-E0D8F94D9065F24F"
],
"osTypes": []
}
]
}Response code
200