Log monitoring metrics API - PUT a metric

Updates the definition of the specified custom log metric.

The request consumes and produces an application/json payload.

Parameters

      
  {
  "metricKey": "calc:log.metric",
  "active": true,
  "displayName": "test metric",
  "unit": "HOUR",
  "unitDisplayName": "",
  "searchString": "search string",
  "metricValueType": "OCCURRENCES",
  "logSourceFilters": [
    {
      "pathDefinitions": [
        {
          "definition": "/var/log/sample.log",
          "type": "FIXED"
        }
      ],
      "sourceEntities": [
        "PROCESS_GROUP_INSTANCE-63FC6E7C73DC893F"
      ],
      "hostFilters": [
        "HOST-066703AD79C38DB5"
      ],
      "osTypes": []
    }
  ]
}
      
    

Possible values

Response format

    
{}
    
  

Response codes

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.

Response codes

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 DESK entity ID PROCESS_GROUP_INSTANCE-6CD96121AD8F5308 that runs on the host with DESK 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 DESK entity IDs that are available in your environment.

Curl

curl -X PUT \
  https://mySampleEnv.live.dexp.ae/api/config/v1/customMetric/log/calc:log.unsecuredcall \
  -H 'Authorization: Api-token abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{<truncated - see the Request body section >}'

Request URL

https://mySampleEnv.live.dexp.ae/api/config/v1/customMetric/log/calc:log.unsecuredcall

Request body

{
  "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

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

Response code

201