Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
prometheus.exporter.oracledb
The prometheus.exporter.oracledb component embeds
oracledb_exporter for collecting statistics from a OracleDB server.
Usage
prometheus.exporter.oracledb "<LABEL>" {
connection_string = "<CONNECTION_STRING>"
}Arguments
You can use the following arguments with prometheus.exporter.oracledb:
| Name | Type | Description | Default | Required |
|---|---|---|---|---|
connection_string | secret | The connection string used to connect to an Oracle Database. | yes | |
max_idle_conns | int | Number of maximum idle connections in the connection pool. | 0 | no |
max_open_conns | int | Number of maximum open connections in the connection pool. | 10 | no |
query_timeout | int | The query timeout in seconds. | 5 | no |
The oracledb_exporter running documentation shows the format and provides examples of the connection_string argument:
oracle://user:pass@server/service_name[?OPTION1=VALUE1[&OPTIONn=VALUEn]...]Blocks
The prometheus.exporter.oracledb component doesn’t support any blocks. You can configure this component with arguments.
Exported fields
The following fields are exported and can be referenced by other components.
| Name | Type | Description |
|---|---|---|
targets | list(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 doesn’t expose any component-specific debug information.
Debug metrics
prometheus.exporter.oracledb doesn’t expose any component-specific debug metrics.
Example
The following example uses a prometheus.scrape component to collect metrics from prometheus.exporter.oracledb:
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 Prometheusremote_writecompatible server to send metrics to.<USERNAME>: The username to use for authentication to theremote_writeAPI.<PASSWORD>: The password to use for authentication to theremote_writeAPI.
Compatible components
prometheus.exporter.oracledb has exports that can be consumed by the following components:
- Components that consume Targets
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.
