Powered by Redocly

OpenTelemetry metric exporters

Exports common metrics to a provided OpenTelemetry collector with minimal configuration. Choose between host-metrics and application-metrics (or both).

Create a new otel metric exporter

SecurityaccessToken
Request
query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
required
all-sites (object) or sites (object) or application-deployments (object) or match-site-labels (object)

Defines which sites the configuration should be applied to.

sources
required
Array of strings <enumeration>
  • host-metrics: Host metrics read from the system:host-metrics topic. Only available to site-provider tenants.
  • application-metrics: Per-application, per-service and per-container metrics, read from the system:application-metrics topic.

Metric sources to forward.

protocol
string <enumeration>
Default: "grpc"
  • http-json: OTLP/HTTP with a JSON-encoded body, posted to base-url with path appended.
  • http-protobuf: OTLP/HTTP with a Protobuf-encoded body, posted to base-url with path appended.
  • grpc: OTLP/gRPC with a Protobuf-encoded body sent over an HTTP/2 connection that is kept open between messages. With this protocol, path is not used and headers are sent as gRPC metadata.

OTLP protocol used to deliver the metrics. Note that Unless base-url includes a port, the destination port is determined by the protocol as 4317 for grpc and 4318 for http-json and http-protobuf.

base-url
required
string <uri>

Base URL of the OpenTelemetry collector. For the http-json and http-protobuf protocols, path (/v1/metrics by default) is appended automatically. Use an https URL to export over TLS. If no port is given here one is selected based on the chosen protocol.

path
string
Default: "/v1/metrics"

Path appended to base-url when posting metrics. Not used when protocol is grpc.

tls-verify
boolean
Default: true

This field can be used to disable server certificate validation when connecting to the remote endpoint. It should only be set to false in test setups and never in production.

ca-cert
string <ca-cert>

One or more root certificates in PEM format.

CA certificates, in PEM format, to use when validating the TLS connection to the remote endpoint. Multiple certificates may be added as one string.

use-root-ca-certs
boolean
Default: true

Use root CA certificate bundle when validating the certificate of the remote endpoint.

server-name-indication
string

If the URL is HTTPS, this field can be used to configure which name must be present in the certificate presented by the server. By default, the host name from the URL is used.

tries
integer <uint32>
Default: 1

If an export fails, this is the number of attempts to make before dropping a message and moving on. 0 means infinite attempts. Note that the default here is 1, not 0 as in the webhooks exporter.

Array of value-from-vault-secret (object)

Variable definitions for use in request headers. For metric exporters, only vault secrets are allowed as variables.

Array of objects

HTTP headers added to every POST request, e.g. for an Authorization bearer token. Header values can contain variables, e.g. Bearer ${TOKEN}.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict (instance exists)

503

Service Unavailable (strongbox sealed)

post/v1/config/volga/otel-metric-exporters
Request samples 
name: my-metric-exporter
site-placement:
  all-sites: true
sources:
  - host-metrics
  - application-metrics
protocol: http-protobuf
base-url: https://otel-collector.example.com
path: /v1/metrics
tls-verify: true
ca-cert: |
  -----BEGIN CERTIFICATE-----
  MIIDUDCCAvagAwIBAgITAKYom2ar3MFwt//DipR5NywBdjAKBggqhkjOPQQDAjBa
  MQ8wDQYDVQQDEwZBdmFzc2ExEjAQBgNVBAcTCVN0b2NraG9sbTELMAkGA1UEBhMC
  U0UxDzANBgNVBAoTBkF2YXNzYTEVMBMGA1UECxMMZGlzdHJpYnV0aW9uMCIYDzIw
  MjIwMTEyMDYyMTQ4WhgPMjAyMjAxMjcwOTU3NDhaMGIxFzAVBgNVBAMTDnRpby5h
  dmFzc2EubmV0MRIwEAYDVQQHEwlTdG9ja2hvbG0xCzAJBgNVBAYTAlNFMQ8wDQYD
  VQQKEwZBdmFzc2ExFTATBgNVBAsTDGRpc3RyaWJ1dGlvbjCCASIwDQYJKoZIhvcN
  AQEBBQADggEPADCCAQoCggEBAKa7LYXK0P1IOpXkEAI52kJizdUA74z7NsAegV38
  LFvipzCggEJr9niqRNmZqR6B8cs+CWIRZub0Qm5eQIzPtZtzLzwBD+i5AyitW5Tq
  Top79tVlta4wupAtkxBCOeIAzFtFwWaiGCVA+4D9Ns6TXo7GUxC0aw/MOeRyAHt/
  HaBIPk6hIGKOAiCjP4r4fEl4tWpSNzexovCvKCl4fGs4WLvRR1YoNdx0spvROc63
  hd9gikokDEuHMsh9Q1wEIP7/V+rgbYGtRw990mHl0zWoGtS+hp/QHAngcJnJiJk3
  gOPTXnQKqCzBWUmZUdwt27LKTdK7Vsq6DtNEKchaqRzGMRkCAwEAAaOBwzCBwDB+
  BgNVHSMEdzB1oV6kXDBaMQ8wDQYDVQQDEwZBdmFzc2ExEjAQBgNVBAcTCVN0b2Nr
  aG9sbTELMAkGA1UEBhMCU0UxDzANBgNVBAoTBkF2YXNzYTEVMBMGA1UECxMMZGlz
  dHJpYnV0aW9ughMAp0MSfyaImp0XtPO3uqCnMRITMCMGA1UdEQQcMBqCDnRpby5h
  dmFzc2EubmV0ggNmb2+CA2JhcjALBgNVHQ8EBAMCA4gwDAYDVR0TAQH/BAIwADAK
  BggqhkjOPQQDAgNIADBFAiAssZp0WV7ejre85Zh4LJZQiTVWEObLXRwifAHQoiqi
  iwIhAOga9thMhWISM1FFgSTeNUtUe9jziVdPfSYQpInAcg3V
  -----END CERTIFICATE-----
use-root-ca-certs: true
server-name-indication: otel-collector
tries: 1
variables:
  - name: token
    value-from-vault-secret:
      from-tenant: telco
      vault: myvault
      secret: mysecret
      key: mykey
headers:
  - name: Authorization
    value: Bearer ${token}

Retrieve the configuration of all otel metric exporters

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

where
string

Retrieve only items matching the given expression.

See section where

validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
keys
string <enumeration>

Retrieve only the keys for the list

Value: "true"
count
string <enumeration>

Retrieve only the number of elements in the list

Value: "true"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/volga/otel-metric-exporters
Response samples 
- name: my-metric-exporter
  site-placement:
    all-sites: true
  sources:
    - host-metrics
    - application-metrics
  protocol: http-protobuf
  base-url: https://otel-collector.example.com
  path: /v1/metrics
  tls-verify: true
  ca-cert: |
    -----BEGIN CERTIFICATE-----
    MIIDUDCCAvagAwIBAgITAKYom2ar3MFwt//DipR5NywBdjAKBggqhkjOPQQDAjBa
    MQ8wDQYDVQQDEwZBdmFzc2ExEjAQBgNVBAcTCVN0b2NraG9sbTELMAkGA1UEBhMC
    U0UxDzANBgNVBAoTBkF2YXNzYTEVMBMGA1UECxMMZGlzdHJpYnV0aW9uMCIYDzIw
    MjIwMTEyMDYyMTQ4WhgPMjAyMjAxMjcwOTU3NDhaMGIxFzAVBgNVBAMTDnRpby5h
    dmFzc2EubmV0MRIwEAYDVQQHEwlTdG9ja2hvbG0xCzAJBgNVBAYTAlNFMQ8wDQYD
    VQQKEwZBdmFzc2ExFTATBgNVBAsTDGRpc3RyaWJ1dGlvbjCCASIwDQYJKoZIhvcN
    AQEBBQADggEPADCCAQoCggEBAKa7LYXK0P1IOpXkEAI52kJizdUA74z7NsAegV38
    LFvipzCggEJr9niqRNmZqR6B8cs+CWIRZub0Qm5eQIzPtZtzLzwBD+i5AyitW5Tq
    Top79tVlta4wupAtkxBCOeIAzFtFwWaiGCVA+4D9Ns6TXo7GUxC0aw/MOeRyAHt/
    HaBIPk6hIGKOAiCjP4r4fEl4tWpSNzexovCvKCl4fGs4WLvRR1YoNdx0spvROc63
    hd9gikokDEuHMsh9Q1wEIP7/V+rgbYGtRw990mHl0zWoGtS+hp/QHAngcJnJiJk3
    gOPTXnQKqCzBWUmZUdwt27LKTdK7Vsq6DtNEKchaqRzGMRkCAwEAAaOBwzCBwDB+
    BgNVHSMEdzB1oV6kXDBaMQ8wDQYDVQQDEwZBdmFzc2ExEjAQBgNVBAcTCVN0b2Nr
    aG9sbTELMAkGA1UEBhMCU0UxDzANBgNVBAoTBkF2YXNzYTEVMBMGA1UECxMMZGlz
    dHJpYnV0aW9ughMAp0MSfyaImp0XtPO3uqCnMRITMCMGA1UdEQQcMBqCDnRpby5h
    dmFzc2EubmV0ggNmb2+CA2JhcjALBgNVHQ8EBAMCA4gwDAYDVR0TAQH/BAIwADAK
    BggqhkjOPQQDAgNIADBFAiAssZp0WV7ejre85Zh4LJZQiTVWEObLXRwifAHQoiqi
    iwIhAOga9thMhWISM1FFgSTeNUtUe9jziVdPfSYQpInAcg3V
    -----END CERTIFICATE-----
  use-root-ca-certs: true
  server-name-indication: otel-collector
  tries: 1
  variables:
    - name: token
      value-from-vault-secret:
        from-tenant: telco
        vault: myvault
        secret: mysecret
        key: mykey
  headers:
    - name: Authorization
      value: Bearer ${token}

Update an otel metric exporter

SecurityaccessToken
Request
path Parameters
otel-metric-exporter-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of otel-metric-exporter

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
required
all-sites (object) or sites (object) or application-deployments (object) or match-site-labels (object)

Defines which sites the configuration should be applied to.

sources
required
Array of strings <enumeration>
  • host-metrics: Host metrics read from the system:host-metrics topic. Only available to site-provider tenants.
  • application-metrics: Per-application, per-service and per-container metrics, read from the system:application-metrics topic.

Metric sources to forward.

protocol
string <enumeration>
Default: "grpc"
  • http-json: OTLP/HTTP with a JSON-encoded body, posted to base-url with path appended.
  • http-protobuf: OTLP/HTTP with a Protobuf-encoded body, posted to base-url with path appended.
  • grpc: OTLP/gRPC with a Protobuf-encoded body sent over an HTTP/2 connection that is kept open between messages. With this protocol, path is not used and headers are sent as gRPC metadata.

OTLP protocol used to deliver the metrics. Note that Unless base-url includes a port, the destination port is determined by the protocol as 4317 for grpc and 4318 for http-json and http-protobuf.

base-url
required
string <uri>

Base URL of the OpenTelemetry collector. For the http-json and http-protobuf protocols, path (/v1/metrics by default) is appended automatically. Use an https URL to export over TLS. If no port is given here one is selected based on the chosen protocol.

path
string
Default: "/v1/metrics"

Path appended to base-url when posting metrics. Not used when protocol is grpc.

tls-verify
boolean
Default: true

This field can be used to disable server certificate validation when connecting to the remote endpoint. It should only be set to false in test setups and never in production.

ca-cert
string <ca-cert>

One or more root certificates in PEM format.

CA certificates, in PEM format, to use when validating the TLS connection to the remote endpoint. Multiple certificates may be added as one string.

use-root-ca-certs
boolean
Default: true

Use root CA certificate bundle when validating the certificate of the remote endpoint.

server-name-indication
string

If the URL is HTTPS, this field can be used to configure which name must be present in the certificate presented by the server. By default, the host name from the URL is used.

tries
integer <uint32>
Default: 1

If an export fails, this is the number of attempts to make before dropping a message and moving on. 0 means infinite attempts. Note that the default here is 1, not 0 as in the webhooks exporter.

Array of value-from-vault-secret (object)

Variable definitions for use in request headers. For metric exporters, only vault secrets are allowed as variables.

Array of objects

HTTP headers added to every POST request, e.g. for an Authorization bearer token. Header values can contain variables, e.g. Bearer ${TOKEN}.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

patch/v1/config/volga/otel-metric-exporters/{otel-metric-exporter-name}
Request samples 
name: my-metric-exporter
site-placement:
  all-sites: true
sources:
  - host-metrics
  - application-metrics
protocol: http-protobuf
base-url: https://otel-collector.example.com
path: /v1/metrics
tls-verify: true
ca-cert: |
  -----BEGIN CERTIFICATE-----
  MIIDUDCCAvagAwIBAgITAKYom2ar3MFwt//DipR5NywBdjAKBggqhkjOPQQDAjBa
  MQ8wDQYDVQQDEwZBdmFzc2ExEjAQBgNVBAcTCVN0b2NraG9sbTELMAkGA1UEBhMC
  U0UxDzANBgNVBAoTBkF2YXNzYTEVMBMGA1UECxMMZGlzdHJpYnV0aW9uMCIYDzIw
  MjIwMTEyMDYyMTQ4WhgPMjAyMjAxMjcwOTU3NDhaMGIxFzAVBgNVBAMTDnRpby5h
  dmFzc2EubmV0MRIwEAYDVQQHEwlTdG9ja2hvbG0xCzAJBgNVBAYTAlNFMQ8wDQYD
  VQQKEwZBdmFzc2ExFTATBgNVBAsTDGRpc3RyaWJ1dGlvbjCCASIwDQYJKoZIhvcN
  AQEBBQADggEPADCCAQoCggEBAKa7LYXK0P1IOpXkEAI52kJizdUA74z7NsAegV38
  LFvipzCggEJr9niqRNmZqR6B8cs+CWIRZub0Qm5eQIzPtZtzLzwBD+i5AyitW5Tq
  Top79tVlta4wupAtkxBCOeIAzFtFwWaiGCVA+4D9Ns6TXo7GUxC0aw/MOeRyAHt/
  HaBIPk6hIGKOAiCjP4r4fEl4tWpSNzexovCvKCl4fGs4WLvRR1YoNdx0spvROc63
  hd9gikokDEuHMsh9Q1wEIP7/V+rgbYGtRw990mHl0zWoGtS+hp/QHAngcJnJiJk3
  gOPTXnQKqCzBWUmZUdwt27LKTdK7Vsq6DtNEKchaqRzGMRkCAwEAAaOBwzCBwDB+
  BgNVHSMEdzB1oV6kXDBaMQ8wDQYDVQQDEwZBdmFzc2ExEjAQBgNVBAcTCVN0b2Nr
  aG9sbTELMAkGA1UEBhMCU0UxDzANBgNVBAoTBkF2YXNzYTEVMBMGA1UECxMMZGlz
  dHJpYnV0aW9ughMAp0MSfyaImp0XtPO3uqCnMRITMCMGA1UdEQQcMBqCDnRpby5h
  dmFzc2EubmV0ggNmb2+CA2JhcjALBgNVHQ8EBAMCA4gwDAYDVR0TAQH/BAIwADAK
  BggqhkjOPQQDAgNIADBFAiAssZp0WV7ejre85Zh4LJZQiTVWEObLXRwifAHQoiqi
  iwIhAOga9thMhWISM1FFgSTeNUtUe9jziVdPfSYQpInAcg3V
  -----END CERTIFICATE-----
use-root-ca-certs: true
server-name-indication: otel-collector
tries: 1
variables:
  - name: token
    value-from-vault-secret:
      from-tenant: telco
      vault: myvault
      secret: mysecret
      key: mykey
headers:
  - name: Authorization
    value: Bearer ${token}

Delete an otel metric exporter

SecurityaccessToken
Request
path Parameters
otel-metric-exporter-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of otel-metric-exporter

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

delete/v1/config/volga/otel-metric-exporters/{otel-metric-exporter-name}

Replace or create a new otel metric exporter

SecurityaccessToken
Request
path Parameters
otel-metric-exporter-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of otel-metric-exporter

query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
name
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
required
all-sites (object) or sites (object) or application-deployments (object) or match-site-labels (object)

Defines which sites the configuration should be applied to.

sources
required
Array of strings <enumeration>
  • host-metrics: Host metrics read from the system:host-metrics topic. Only available to site-provider tenants.
  • application-metrics: Per-application, per-service and per-container metrics, read from the system:application-metrics topic.

Metric sources to forward.

protocol
string <enumeration>
Default: "grpc"
  • http-json: OTLP/HTTP with a JSON-encoded body, posted to base-url with path appended.
  • http-protobuf: OTLP/HTTP with a Protobuf-encoded body, posted to base-url with path appended.
  • grpc: OTLP/gRPC with a Protobuf-encoded body sent over an HTTP/2 connection that is kept open between messages. With this protocol, path is not used and headers are sent as gRPC metadata.

OTLP protocol used to deliver the metrics. Note that Unless base-url includes a port, the destination port is determined by the protocol as 4317 for grpc and 4318 for http-json and http-protobuf.

base-url
required
string <uri>

Base URL of the OpenTelemetry collector. For the http-json and http-protobuf protocols, path (/v1/metrics by default) is appended automatically. Use an https URL to export over TLS. If no port is given here one is selected based on the chosen protocol.

path
string
Default: "/v1/metrics"

Path appended to base-url when posting metrics. Not used when protocol is grpc.

tls-verify
boolean
Default: true

This field can be used to disable server certificate validation when connecting to the remote endpoint. It should only be set to false in test setups and never in production.

ca-cert
string <ca-cert>

One or more root certificates in PEM format.

CA certificates, in PEM format, to use when validating the TLS connection to the remote endpoint. Multiple certificates may be added as one string.

use-root-ca-certs
boolean
Default: true

Use root CA certificate bundle when validating the certificate of the remote endpoint.

server-name-indication
string

If the URL is HTTPS, this field can be used to configure which name must be present in the certificate presented by the server. By default, the host name from the URL is used.

tries
integer <uint32>
Default: 1

If an export fails, this is the number of attempts to make before dropping a message and moving on. 0 means infinite attempts. Note that the default here is 1, not 0 as in the webhooks exporter.

Array of value-from-vault-secret (object)

Variable definitions for use in request headers. For metric exporters, only vault secrets are allowed as variables.

Array of objects

HTTP headers added to every POST request, e.g. for an Authorization bearer token. Header values can contain variables, e.g. Bearer ${TOKEN}.

Responses
201

Created

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

put/v1/config/volga/otel-metric-exporters/{otel-metric-exporter-name}
Request samples 
name: my-metric-exporter
site-placement:
  all-sites: true
sources:
  - host-metrics
  - application-metrics
protocol: http-protobuf
base-url: https://otel-collector.example.com
path: /v1/metrics
tls-verify: true
ca-cert: |
  -----BEGIN CERTIFICATE-----
  MIIDUDCCAvagAwIBAgITAKYom2ar3MFwt//DipR5NywBdjAKBggqhkjOPQQDAjBa
  MQ8wDQYDVQQDEwZBdmFzc2ExEjAQBgNVBAcTCVN0b2NraG9sbTELMAkGA1UEBhMC
  U0UxDzANBgNVBAoTBkF2YXNzYTEVMBMGA1UECxMMZGlzdHJpYnV0aW9uMCIYDzIw
  MjIwMTEyMDYyMTQ4WhgPMjAyMjAxMjcwOTU3NDhaMGIxFzAVBgNVBAMTDnRpby5h
  dmFzc2EubmV0MRIwEAYDVQQHEwlTdG9ja2hvbG0xCzAJBgNVBAYTAlNFMQ8wDQYD
  VQQKEwZBdmFzc2ExFTATBgNVBAsTDGRpc3RyaWJ1dGlvbjCCASIwDQYJKoZIhvcN
  AQEBBQADggEPADCCAQoCggEBAKa7LYXK0P1IOpXkEAI52kJizdUA74z7NsAegV38
  LFvipzCggEJr9niqRNmZqR6B8cs+CWIRZub0Qm5eQIzPtZtzLzwBD+i5AyitW5Tq
  Top79tVlta4wupAtkxBCOeIAzFtFwWaiGCVA+4D9Ns6TXo7GUxC0aw/MOeRyAHt/
  HaBIPk6hIGKOAiCjP4r4fEl4tWpSNzexovCvKCl4fGs4WLvRR1YoNdx0spvROc63
  hd9gikokDEuHMsh9Q1wEIP7/V+rgbYGtRw990mHl0zWoGtS+hp/QHAngcJnJiJk3
  gOPTXnQKqCzBWUmZUdwt27LKTdK7Vsq6DtNEKchaqRzGMRkCAwEAAaOBwzCBwDB+
  BgNVHSMEdzB1oV6kXDBaMQ8wDQYDVQQDEwZBdmFzc2ExEjAQBgNVBAcTCVN0b2Nr
  aG9sbTELMAkGA1UEBhMCU0UxDzANBgNVBAoTBkF2YXNzYTEVMBMGA1UECxMMZGlz
  dHJpYnV0aW9ughMAp0MSfyaImp0XtPO3uqCnMRITMCMGA1UdEQQcMBqCDnRpby5h
  dmFzc2EubmV0ggNmb2+CA2JhcjALBgNVHQ8EBAMCA4gwDAYDVR0TAQH/BAIwADAK
  BggqhkjOPQQDAgNIADBFAiAssZp0WV7ejre85Zh4LJZQiTVWEObLXRwifAHQoiqi
  iwIhAOga9thMhWISM1FFgSTeNUtUe9jziVdPfSYQpInAcg3V
  -----END CERTIFICATE-----
use-root-ca-certs: true
server-name-indication: otel-collector
tries: 1
variables:
  - name: token
    value-from-vault-secret:
      from-tenant: telco
      vault: myvault
      secret: mysecret
      key: mykey
headers:
  - name: Authorization
    value: Bearer ${token}

Retrieve the configuration of an otel metric exporter

SecurityaccessToken
Request
path Parameters
otel-metric-exporter-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of otel-metric-exporter

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

where
string

Retrieve only items matching the given expression.

See section where

validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/volga/otel-metric-exporters/{otel-metric-exporter-name}
Response samples 
name: my-metric-exporter
site-placement:
  all-sites: true
sources:
  - host-metrics
  - application-metrics
protocol: http-protobuf
base-url: https://otel-collector.example.com
path: /v1/metrics
tls-verify: true
ca-cert: |
  -----BEGIN CERTIFICATE-----
  MIIDUDCCAvagAwIBAgITAKYom2ar3MFwt//DipR5NywBdjAKBggqhkjOPQQDAjBa
  MQ8wDQYDVQQDEwZBdmFzc2ExEjAQBgNVBAcTCVN0b2NraG9sbTELMAkGA1UEBhMC
  U0UxDzANBgNVBAoTBkF2YXNzYTEVMBMGA1UECxMMZGlzdHJpYnV0aW9uMCIYDzIw
  MjIwMTEyMDYyMTQ4WhgPMjAyMjAxMjcwOTU3NDhaMGIxFzAVBgNVBAMTDnRpby5h
  dmFzc2EubmV0MRIwEAYDVQQHEwlTdG9ja2hvbG0xCzAJBgNVBAYTAlNFMQ8wDQYD
  VQQKEwZBdmFzc2ExFTATBgNVBAsTDGRpc3RyaWJ1dGlvbjCCASIwDQYJKoZIhvcN
  AQEBBQADggEPADCCAQoCggEBAKa7LYXK0P1IOpXkEAI52kJizdUA74z7NsAegV38
  LFvipzCggEJr9niqRNmZqR6B8cs+CWIRZub0Qm5eQIzPtZtzLzwBD+i5AyitW5Tq
  Top79tVlta4wupAtkxBCOeIAzFtFwWaiGCVA+4D9Ns6TXo7GUxC0aw/MOeRyAHt/
  HaBIPk6hIGKOAiCjP4r4fEl4tWpSNzexovCvKCl4fGs4WLvRR1YoNdx0spvROc63
  hd9gikokDEuHMsh9Q1wEIP7/V+rgbYGtRw990mHl0zWoGtS+hp/QHAngcJnJiJk3
  gOPTXnQKqCzBWUmZUdwt27LKTdK7Vsq6DtNEKchaqRzGMRkCAwEAAaOBwzCBwDB+
  BgNVHSMEdzB1oV6kXDBaMQ8wDQYDVQQDEwZBdmFzc2ExEjAQBgNVBAcTCVN0b2Nr
  aG9sbTELMAkGA1UEBhMCU0UxDzANBgNVBAoTBkF2YXNzYTEVMBMGA1UECxMMZGlz
  dHJpYnV0aW9ughMAp0MSfyaImp0XtPO3uqCnMRITMCMGA1UdEQQcMBqCDnRpby5h
  dmFzc2EubmV0ggNmb2+CA2JhcjALBgNVHQ8EBAMCA4gwDAYDVR0TAQH/BAIwADAK
  BggqhkjOPQQDAgNIADBFAiAssZp0WV7ejre85Zh4LJZQiTVWEObLXRwifAHQoiqi
  iwIhAOga9thMhWISM1FFgSTeNUtUe9jziVdPfSYQpInAcg3V
  -----END CERTIFICATE-----
use-root-ca-certs: true
server-name-indication: otel-collector
tries: 1
variables:
  - name: token
    value-from-vault-secret:
      from-tenant: telco
      vault: myvault
      secret: mysecret
      key: mykey
headers:
  - name: Authorization
    value: Bearer ${token}

Retrieve the state of all otel metric exporters

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

where
string

Retrieve only items matching the given expression.

See section where

site
string

Send the request to the specfifed site

content
string <enumeration>

Filter descendant nodes in the response

Enum: "config" "nonconfig"
keys
string <enumeration>

Retrieve only the keys for the list

Value: "true"
count
string <enumeration>

Retrieve only the number of elements in the list

Value: "true"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/volga/otel-metric-exporters
Response samples 
- name: my-metric-exporter
  site-placement:
    all-sites: true
  sources:
    - host-metrics
    - application-metrics
  protocol: http-protobuf
  base-url: https://otel-collector.example.com
  path: /v1/metrics
  tls-verify: true
  ca-cert: |
    -----BEGIN CERTIFICATE-----
    MIIDUDCCAvagAwIBAgITAKYom2ar3MFwt//DipR5NywBdjAKBggqhkjOPQQDAjBa
    MQ8wDQYDVQQDEwZBdmFzc2ExEjAQBgNVBAcTCVN0b2NraG9sbTELMAkGA1UEBhMC
    U0UxDzANBgNVBAoTBkF2YXNzYTEVMBMGA1UECxMMZGlzdHJpYnV0aW9uMCIYDzIw
    MjIwMTEyMDYyMTQ4WhgPMjAyMjAxMjcwOTU3NDhaMGIxFzAVBgNVBAMTDnRpby5h
    dmFzc2EubmV0MRIwEAYDVQQHEwlTdG9ja2hvbG0xCzAJBgNVBAYTAlNFMQ8wDQYD
    VQQKEwZBdmFzc2ExFTATBgNVBAsTDGRpc3RyaWJ1dGlvbjCCASIwDQYJKoZIhvcN
    AQEBBQADggEPADCCAQoCggEBAKa7LYXK0P1IOpXkEAI52kJizdUA74z7NsAegV38
    LFvipzCggEJr9niqRNmZqR6B8cs+CWIRZub0Qm5eQIzPtZtzLzwBD+i5AyitW5Tq
    Top79tVlta4wupAtkxBCOeIAzFtFwWaiGCVA+4D9Ns6TXo7GUxC0aw/MOeRyAHt/
    HaBIPk6hIGKOAiCjP4r4fEl4tWpSNzexovCvKCl4fGs4WLvRR1YoNdx0spvROc63
    hd9gikokDEuHMsh9Q1wEIP7/V+rgbYGtRw990mHl0zWoGtS+hp/QHAngcJnJiJk3
    gOPTXnQKqCzBWUmZUdwt27LKTdK7Vsq6DtNEKchaqRzGMRkCAwEAAaOBwzCBwDB+
    BgNVHSMEdzB1oV6kXDBaMQ8wDQYDVQQDEwZBdmFzc2ExEjAQBgNVBAcTCVN0b2Nr
    aG9sbTELMAkGA1UEBhMCU0UxDzANBgNVBAoTBkF2YXNzYTEVMBMGA1UECxMMZGlz
    dHJpYnV0aW9ughMAp0MSfyaImp0XtPO3uqCnMRITMCMGA1UdEQQcMBqCDnRpby5h
    dmFzc2EubmV0ggNmb2+CA2JhcjALBgNVHQ8EBAMCA4gwDAYDVR0TAQH/BAIwADAK
    BggqhkjOPQQDAgNIADBFAiAssZp0WV7ejre85Zh4LJZQiTVWEObLXRwifAHQoiqi
    iwIhAOga9thMhWISM1FFgSTeNUtUe9jziVdPfSYQpInAcg3V
    -----END CERTIFICATE-----
  use-root-ca-certs: true
  server-name-indication: otel-collector
  tries: 1
  variables:
    - name: token
      value-from-vault-secret:
        from-tenant: telco
        vault: myvault
        secret: mysecret
        key: mykey
  headers:
    - name: Authorization
      value: Bearer ${token}
  status: ready
  start-time: 2026-05-26T10:35:11.123Z
  consumed-topics:
    - system:host-metrics
    - system:application-metrics
  last-error-time: 2026-05-27T10:12:09.123Z
  last-error: "Bad POST response: 500"

Retrieve the state of an otel metric exporter

SecurityaccessToken
Request
path Parameters
otel-metric-exporter-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of otel-metric-exporter

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

where
string

Retrieve only items matching the given expression.

See section where

site
string

Send the request to the specfifed site

content
string <enumeration>

Filter descendant nodes in the response

Enum: "config" "nonconfig"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/volga/otel-metric-exporters/{otel-metric-exporter-name}
Response samples 
name: my-metric-exporter
site-placement:
  all-sites: true
sources:
  - host-metrics
  - application-metrics
protocol: http-protobuf
base-url: https://otel-collector.example.com
path: /v1/metrics
tls-verify: true
ca-cert: |
  -----BEGIN CERTIFICATE-----
  MIIDUDCCAvagAwIBAgITAKYom2ar3MFwt//DipR5NywBdjAKBggqhkjOPQQDAjBa
  MQ8wDQYDVQQDEwZBdmFzc2ExEjAQBgNVBAcTCVN0b2NraG9sbTELMAkGA1UEBhMC
  U0UxDzANBgNVBAoTBkF2YXNzYTEVMBMGA1UECxMMZGlzdHJpYnV0aW9uMCIYDzIw
  MjIwMTEyMDYyMTQ4WhgPMjAyMjAxMjcwOTU3NDhaMGIxFzAVBgNVBAMTDnRpby5h
  dmFzc2EubmV0MRIwEAYDVQQHEwlTdG9ja2hvbG0xCzAJBgNVBAYTAlNFMQ8wDQYD
  VQQKEwZBdmFzc2ExFTATBgNVBAsTDGRpc3RyaWJ1dGlvbjCCASIwDQYJKoZIhvcN
  AQEBBQADggEPADCCAQoCggEBAKa7LYXK0P1IOpXkEAI52kJizdUA74z7NsAegV38
  LFvipzCggEJr9niqRNmZqR6B8cs+CWIRZub0Qm5eQIzPtZtzLzwBD+i5AyitW5Tq
  Top79tVlta4wupAtkxBCOeIAzFtFwWaiGCVA+4D9Ns6TXo7GUxC0aw/MOeRyAHt/
  HaBIPk6hIGKOAiCjP4r4fEl4tWpSNzexovCvKCl4fGs4WLvRR1YoNdx0spvROc63
  hd9gikokDEuHMsh9Q1wEIP7/V+rgbYGtRw990mHl0zWoGtS+hp/QHAngcJnJiJk3
  gOPTXnQKqCzBWUmZUdwt27LKTdK7Vsq6DtNEKchaqRzGMRkCAwEAAaOBwzCBwDB+
  BgNVHSMEdzB1oV6kXDBaMQ8wDQYDVQQDEwZBdmFzc2ExEjAQBgNVBAcTCVN0b2Nr
  aG9sbTELMAkGA1UEBhMCU0UxDzANBgNVBAoTBkF2YXNzYTEVMBMGA1UECxMMZGlz
  dHJpYnV0aW9ughMAp0MSfyaImp0XtPO3uqCnMRITMCMGA1UdEQQcMBqCDnRpby5h
  dmFzc2EubmV0ggNmb2+CA2JhcjALBgNVHQ8EBAMCA4gwDAYDVR0TAQH/BAIwADAK
  BggqhkjOPQQDAgNIADBFAiAssZp0WV7ejre85Zh4LJZQiTVWEObLXRwifAHQoiqi
  iwIhAOga9thMhWISM1FFgSTeNUtUe9jziVdPfSYQpInAcg3V
  -----END CERTIFICATE-----
use-root-ca-certs: true
server-name-indication: otel-collector
tries: 1
variables:
  - name: token
    value-from-vault-secret:
      from-tenant: telco
      vault: myvault
      secret: mysecret
      key: mykey
headers:
  - name: Authorization
    value: Bearer ${token}
status: ready
start-time: 2026-05-26T10:35:11.123Z
consumed-topics:
  - system:host-metrics
  - system:application-metrics
last-error-time: 2026-05-27T10:12:09.123Z
last-error: "Bad POST response: 500"

Invoke the restart operation

Restarts the metric exporter.

SecurityaccessToken
Request
path Parameters
otel-metric-exporter-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of otel-metric-exporter

query Parameters
site
string

Send the request to the specfifed site

Responses
204

No Content

400
401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/volga/otel-metric-exporters/{otel-metric-exporter-name}/restart
Response samples
No sample
➔ Next to Query Topics