spotf stream egress-route create-or-update open-telemetry

Create/Update OpenTelemetry Egress Route.

The Egress Route can be configured to add labels for logs, metrics and traces signals. Tha available labels are:

• deviceId
• siteId
• streamGroupName
• streamName

To specify the label that should be added to the signal, use the corresponding parameter with value adhering to the following syntax: '(labelName):(bool)'.

Example: '--log-labels deviceId:true'.

Multiple labels per signal can be specified by using the corresponding parameter multiple times.

If the label is not specified, existing configuration is not changed. To remove previously added label, set the value to 'false'.

Arguments

None.

Options

--stream-group-name: Stream Group name

• Required.
• Value = [string]

---

--stream-name: Stream name

• Required.
• Value = [string]

---

--egress-route-name: Egress Route name

• Required.
• Value = [string]

---

--log-labels: Labels to add to logs. See details in the command description.

• Value = [string]

---

--metrics-labels: Labels to add to metrics. See details in the command description.

• Value = [string]

---

--traces-labels: Labels to add to traces. See details in the command description.

• Value = [string]

---

--egress-sink-name: Egress Sink name. (Must be provided for a new Egress Route.)

• Value = [string]

---

--notification-input: Notification input type. (Message notifications - Contains payload and metadata of individual messages. Batch completion notification - Contains a link to the blob prefix in the stream storage where all messages from the batch are stored.)

• Value = [Messages|BatchCompletions]

---

--is-enabled: Specifies whether to enable or disable the routing of notifications to the Egress Sink. By default, the routing of notifications to the Egress Sink is enabled when creating a new Egress Route.To disable it, use the option '--is-enabled false'.

---

--with-filter: Specifies the condition to filter notifications sent to the Egress Sink. For example, by enabling the next condition 'starts_with(metadata.deviceId, 'test_') OR metadata.deviceId = 'my_awesome_device'', the platform will send to Egress Sink only those notifications, which coming from devices with IDs like 'test_device_1', 'my_awesome_device' etc. By default, the filtering is disabled for new routes. To disable already enabled one, use the option '--without-filter'.

• Value = [string]

---

--without-filter: Do not use filtering.

---

--instance-label: Label for IoT Platform instance

• Value = [string]

---

--workspace: Workspace ID / Name

• Value = [string]

---