Menu

This is documentation for the next version of Alloy. For the latest stable release, go to the latest version.

Open source

prometheus.exporter.oracledb

The prometheus.exporter.oracledb component embeds oracledb_exporter for collecting statistics from a OracleDB server.

Usage

alloy
prometheus.exporter.oracledb "LABEL" {
    connection_string = CONNECTION_STRING
}

Arguments

The following arguments can be used to configure the exporter’s behavior. Omitted fields take their default values.

NameTypeDescriptionDefaultRequired
connection_stringsecretThe connection string used to connect to an Oracle Database.yes
max_idle_connsintNumber of maximum idle connections in the connection pool.0no
max_open_connsintNumber of maximum open connections in the connection pool.10no
query_timeoutintThe query timeout in seconds.5no

The oracledb_exporter running documentation shows the format and provides examples of the connection_string argument:

conn
oracle://user:pass@server/service_name[?OPTION1=VALUE1[&OPTIONn=VALUEn]...]

Blocks

The prometheus.exporter.oracledb component does not support any blocks, and is configured fully through arguments.

Exported fields

The following fields are exported and can be referenced by other components.

NameTypeDescription
targetslist(map(string))The targets that can be used to collect exporter metrics.

For example, the targets can either be passed to a discovery.relabel component to rewrite the targets’ label sets or to a prometheus.scrape component that collects the exposed metrics.

The exported targets use the configured in-memory traffic address specified by the run command.

Component health

prometheus.exporter.oracledb is only reported as unhealthy if given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

prometheus.exporter.oracledb does not expose any component-specific debug information.

Debug metrics

prometheus.exporter.oracledb does not expose any component-specific debug metrics.

Example

This example uses a prometheus.scrape component to collect metrics from prometheus.exporter.oracledb:

alloy
prometheus.exporter.oracledb "example" {
  connection_string = "oracle://user:password@localhost:1521/orcl.localnet"
}

// Configure a prometheus.scrape component to collect oracledb metrics.
prometheus.scrape "demo" {
  targets    = prometheus.exporter.oracledb.example.targets
  forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
  endpoint {
    url = PROMETHEUS_REMOTE_WRITE_URL

    basic_auth {
      username = USERNAME
      password = PASSWORD
    }
  }
}

Replace the following:

  • PROMETHEUS_REMOTE_WRITE_URL: The URL of the Prometheus remote_write-compatible server to send metrics to.
  • USERNAME: The username to use for authentication to the remote_write API.
  • PASSWORD: The password to use for authentication to the remote_write API.

Compatible components

prometheus.exporter.oracledb has exports that can be consumed by the following components:

Note

Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.