Replace an E2M

PUThttps://api.coralogix.com/mgmt/openapi/5/events2metrics/events2metrics/v2

Updates an existing events-to-metrics rule.

Authorizations

Authorizationstringheaderrequired

API key authentication

The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request

Body

application/json

oneOf
• Option 1
• Option 2
• Option 3
object
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.
Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[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.

logsQuery# object
metricFields# object[]
Metric fields to extract and aggregate from the events.
Possible values: <= 10
metricLabels# object[]
Metric labels to attach to the generated metrics.
name#stringrequired
Human-readable name for this E2M.
Example: Service_catalog_latency
permutations# object
spansQuery# object
type#E2MTyperequired

E2 m type.

Possible values: [E2M_TYPE_UNSPECIFIED, E2M_TYPE_LOGS2METRICS, E2M_TYPE_SPANS2METRICS]

updateTime#string
RFC3339 timestamp of when this E2M was last updated.
Example: 2022-06-30T12:30:00.000Z

Response

200application/json

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

e2m#objectrequiredoneOf
• Option 1
• Option 2
• Option 3
object
e2m.createTime#string
RFC3339 timestamp of when this E2M was created.
Example: 2022-06-30T12:30:00.000Z
e2m.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
e2m.description#string
Human-readable description of this E2M.
Example: avg and max the latency of catalog service
e2m.id#string
Unique identifier for this E2M. Required on update requests.
Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[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
e2m.isInternal#boolean
Indicates whether this E2M is for internal use only.
e2m.logsQuery# object
e2m.metricFields# object[]
Metric fields to extract and aggregate from the events.
Possible values: <= 10
e2m.metricLabels# object[]
Metric labels to attach to the generated metrics.
e2m.name#stringrequired
Human-readable name for this E2M.
Example: Service_catalog_latency
e2m.permutations# object
e2m.spansQuery# object
e2m.type#E2MTyperequired
E2 m type.
Possible values: [E2M_TYPE_UNSPECIFIED, E2M_TYPE_LOGS2METRICS, E2M_TYPE_SPANS2METRICS]
e2m.updateTime#string
RFC3339 timestamp of when this E2M was last updated.
Example: 2022-06-30T12:30:00.000Z