Skip to main content
Replace an E2M
curl --request PUT \
  --url https://api.coralogix.com/mgmt/openapi/5/events2metrics/events2metrics/v2 \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "logsQuery": {
    "alias": "new_query",
    "applicationnameFilters": [
      "app_name"
    ],
    "lucene": "log_obj.numeric_field: [50 TO 100]",
    "severityFilters": [],
    "subsystemnameFilters": [
      "sub_name"
    ]
  },
  "name": "Service_catalog_latency",
  "createTime": "2022-06-30T12:30:00.000Z",
  "dataSource": "my_namespace/my_dataset",
  "description": "avg and max the latency of catalog service",
  "id": "d6a3658e-78d2-47d0-9b81-b2c551f01b09",
  "isInternal": true,
  "metricFields": [
    {
      "aggregations": [
        {
          "histogram": {
            "buckets": [
              2
            ]
          },
          "enabled": true,
          "targetMetricName": "alias_field_name_agg_func"
        }
      ],
      "sourceField": "log_obj.numeric_field",
      "targetBaseMetricName": "alias_field_name"
    }
  ],
  "metricLabels": [
    {
      "sourceField": "log_obj.string_value",
      "targetLabel": "alias_label_name"
    }
  ],
  "updateTime": "2022-06-30T12:30:00.000Z"
}
'
{
  "e2m": {
    "logsQuery": {
      "alias": "new_query",
      "applicationnameFilters": [
        "app_name"
      ],
      "lucene": "log_obj.numeric_field: [50 TO 100]",
      "severityFilters": [],
      "subsystemnameFilters": [
        "sub_name"
      ]
    },
    "name": "Service_catalog_latency",
    "createTime": "2022-06-30T12:30:00.000Z",
    "dataSource": "my_namespace/my_dataset",
    "description": "avg and max the latency of catalog service",
    "id": "d6a3658e-78d2-47d0-9b81-b2c551f01b09",
    "isInternal": true,
    "metricFields": [
      {
        "aggregations": [
          {
            "histogram": {
              "buckets": [
                2
              ]
            },
            "enabled": true,
            "targetMetricName": "alias_field_name_agg_func"
          }
        ],
        "sourceField": "log_obj.numeric_field",
        "targetBaseMetricName": "alias_field_name"
      }
    ],
    "metricLabels": [
      {
        "sourceField": "log_obj.string_value",
        "targetLabel": "alias_label_name"
      }
    ],
    "permutations": {
      "hasExceededLimit": true,
      "limit": 30000
    },
    "updateTime": "2022-06-30T12:30:00.000Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.coralogix.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key authentication

Body

application/json

This data structure represents an Event to Metrics (E2M) object.

​
logsQuery
SpansQuery · object
required

This data structure represents a query for logs.

​
name
string
required

Human-readable name for this E2M.

Example:

"Service_catalog_latency"

​
type
enum<string>
required

E2 m type.

Available options:
E2M_TYPE_UNSPECIFIED,
E2M_TYPE_LOGS2METRICS,
E2M_TYPE_SPANS2METRICS
​
createTime
string

RFC3339 timestamp of when this E2M was created.

Example:

"2022-06-30T12:30:00.000Z"

​
dataSource
string

Optional data source in namespace/dataset_name format. If not set, defaults to the standard logs/spans stream.

Example:

"my_namespace/my_dataset"

​
description
string

Human-readable description of this E2M.

Example:

"avg and max the latency of catalog service"

​
id
string

Unique identifier for this E2M. Required on update requests.

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"d6a3658e-78d2-47d0-9b81-b2c551f01b09"

​
isInternal
boolean

Indicates whether this E2M is for internal use only.

​
metricFields
Metric Field · object[]

Metric fields to extract and aggregate from the events.

Maximum array length: 10
​
metricLabels
Metric Label · object[]

Metric labels to attach to the generated metrics.

​
permutations
E2M Permutations · object

This data structure represents the limit of events2metrics permutations and if the limit was exceeded

​
updateTime
string

RFC3339 timestamp of when this E2M was last updated.

Example:

"2022-06-30T12:30:00.000Z"

Response

200 - application/json

This data structure is obtained when replacing an existing event to metric definition

​
e2m
E2M · object
required

This data structure represents an Event to Metrics (E2M) object.