Log Monitoring metrics API - PUT a metric

Updates the descriptor of the specified calculated Log Monitoring metric.

The request consumes and produces an application/json payload.

Parameters

jsoncopydownload
{
  "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": []
    }
  ]
}

Response

jsoncopydownload
{
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity",
  "description": "Dynatrace entity for the REST API example"
}

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

The request consumes an application/json payload.

Response

Example

In this example, the request creates a new custom log metric with the key of calc:log.unsecuredcall. The metric counts the occurrences of the phrase UNSECURED_SHARED_CALL in 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 API token is passed in the Authorization header.

Because the request body is lengthy, it is truncated in this example Curl section. See the full body in the Request body section. You can download or copy the example request body to try it out on your own. Before using it, make sure that you're using Dynatrace entity IDs that are available in your environment.

Curl

bashcopydownload
curl -X PUT \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/calculatedMetrics/log/calc:log.unsecuredcall \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{<truncated - see the Request body section >}'

Request URL

plaintextcopydownload
https://mySampleEnv.live.dynatrace.com/api/config/v1/calculatedMetrics/log/calc:log.unsecuredcall

Request body

jsoncopydownload
{
  "metricKey": "calc:log.unsecuredcall",
  "active": true,
  "displayName": "Unsecured call",
  "unit": "COUNT",
  "searchString": "UNSECURED_SHARED_CALL",
  "metricValueType": "OCCURRENCES",
  "logSourceFilters": [
    {
      "pathDefinitions": [],
      "sourceEntities": ["PROCESS_GROUP_INSTANCE-6CD96121AD8F5308"],
      "hostFilters": ["HOST-5AA1203365B14DBC"],
      "osTypes": []
    }
  ]
}

Response body

jsoncopydownload
{
  "id": "calc:log.unsecuredcall",
  "name": "Unsecured call"
}

Response code

201