monitor.conf key reference (server-side)¶
Core monitor and tags¶
| Key | Default value | Description |
|---|---|---|
monitor.enabled |
true |
Master switch for monitoring and observability features. |
monitor.tags[].key |
"t1", "t2" |
Global metric/tracing tag key. |
monitor.tags[].value |
"v1", "v2" |
Global metric/tracing tag value. |
JMX and Prometheus registry¶
| Key | Default value | Description |
|---|---|---|
monitor.registries.jmx.enabled |
true |
Enables JMX metrics registry. |
monitor.registries.prometheus.enabled |
true |
Enables Prometheus metrics registry. |
monitor.registries.prometheus.prefix |
"prometheus" |
Prefix used for Prometheus metric naming/registry context. |
monitor.registries.prometheus.descriptions |
true |
Exposes Prometheus metric descriptions/help text. |
monitor.registries.prometheus.step |
60 |
Publish/step interval in seconds. |
monitor.registries.prometheus.properties[].key |
"io.prometheus.exporter.exemplarsOnAllMetricTypes" |
Prometheus exporter property key. |
monitor.registries.prometheus.properties[].value |
"true" |
Prometheus exporter property value. |
monitor.registries.prometheus.http.host |
"any" |
Bind host for Prometheus scrape HTTP server. |
monitor.registries.prometheus.http.port |
8989 |
Bind port for Prometheus scrape HTTP server. |
monitor.registries.prometheus.http.back.log |
10 |
HTTP server backlog queue size. |
monitor.registries.prometheus.http.uri |
"/scrape" |
HTTP path for scrape endpoint. |
monitor.registries.prometheus.http.ssl.enabled |
false |
Enables TLS for scrape endpoint. |
monitor.registries.prometheus.http.ssl.port |
9989 |
HTTPS port when TLS is enabled. |
monitor.registries.prometheus.http.ssl.keystore.server.file |
"" |
Server keystore path for HTTPS scrape endpoint. |
monitor.registries.prometheus.http.ssl.keystore.server.password |
"" |
Server keystore password. |
monitor.registries.prometheus.http.ssl.keystore.server.type |
"PKCS12" |
Server keystore type. |
monitor.registries.prometheus.http.ssl.keystore.server.tls |
"TLSv1.3" |
TLS protocol used by Prometheus HTTPS endpoint. |
monitor.registries.prometheus.http.ssl.keystore.client.enabled |
false |
Enables mutual TLS client authentication for scrape endpoint. |
monitor.registries.prometheus.http.ssl.keystore.client.file |
"" |
Client trust/keystore file path for mTLS. |
monitor.registries.prometheus.http.ssl.keystore.client.password |
"" |
Client trust/keystore password for mTLS. |
monitor.registries.prometheus.http.ssl.keystore.client.type |
"PKCS12" |
Client trust/keystore type. |
OTLP metrics registry¶
| Key | Default value | Description |
|---|---|---|
monitor.registries.otlp.enabled |
false |
Enables OTLP metrics export. |
monitor.registries.otlp.url |
"http://otel-collector:4318/v1/metrics" |
OTLP/HTTP metrics endpoint URL. |
monitor.registries.otlp.step |
"30s" |
OTLP metrics publish interval. |
monitor.registries.otlp.batchSize |
15000 |
OTLP metrics batch payload size. |
monitor.registries.otlp.aggregationTemporality |
"cumulative" |
Aggregation temporality (cumulative or delta). |
monitor.registries.otlp.headers.Authorization |
"Bearer ${?OTLP_TOKEN}" |
Optional Authorization header for OTLP exporter. |
monitor.registries.otlp.resourceAttributes.service.name |
"my-service" |
OTLP resource attribute for service name. |
monitor.registries.otlp.resourceAttributes.service.namespace |
"pki" |
OTLP resource attribute for namespace. |
monitor.registries.otlp.resourceAttributes.deployment.environment |
"prod" |
OTLP resource attribute for environment. |
monitor.registries.otlp.histogramFlavor |
"explicit_bucket_histogram" |
Histogram flavor (explicit_bucket_histogram or base2_exponential_bucket_histogram). |
monitor.registries.otlp.histogramFlavorPerMeter."db.read.duration" |
"explicit_bucket_histogram" |
Per-meter histogram flavor override. |
monitor.registries.otlp.maxScale |
20 |
Maximum scale for exponential histograms (when used). |
monitor.registries.otlp.maxBuckets |
160 |
Maximum bucket count for histograms. |
monitor.registries.otlp.maxBucketsPerMeter."db.read.duration" |
200 |
Per-meter bucket count override. |
Elasticsearch metrics registry¶
| Key | Default value | Description |
|---|---|---|
monitor.registries.elastic.enabled |
false |
Enables Elasticsearch metrics export. |
monitor.registries.elastic.step |
"1m" |
Metrics push interval to Elasticsearch. |
monitor.registries.elastic.host |
"https://es.example.com:9200" |
Elasticsearch endpoint URL. |
monitor.registries.elastic.index |
"pki-metrics" |
Target index name for metrics documents. |
monitor.registries.elastic.autoCreateIndex |
true |
Auto-create index if missing. |
monitor.registries.elastic.enableSource |
false |
Enables _source field in indexed documents. |
monitor.registries.elastic.pipeline |
"pki-ingest" |
Optional ingest pipeline name. |
monitor.registries.elastic.timestampFieldName |
"@timestamp" |
Timestamp field name in exported documents. |
monitor.registries.elastic.indexDateFormat |
"yyyy-MM-dd" |
Date format suffix for rolling index names. |
monitor.registries.elastic.indexDateSeparator |
"-" |
Separator used between index base and date suffix. |
monitor.registries.elastic.userName |
"elastic" |
Basic-auth user name. |
monitor.registries.elastic.password |
"secret" |
Basic-auth password. |
Built-in runtime metrics switches¶
| Key | Default value | Description |
|---|---|---|
monitor.metrics.memory.enabled |
true |
Enables memory metrics. |
monitor.metrics.threads.enabled |
true |
Enables thread metrics. |
monitor.metrics.processor.enabled |
true |
Enables CPU/processor metrics. |
monitor.metrics.uptime.enabled |
true |
Enables process uptime metric. |
Tracing¶
| Key | Default value | Description |
|---|---|---|
monitor.tracing.enabled |
true |
Master switch for tracing. |
monitor.tracing.instrumentation |
annotations |
Instrumentation mode (annotations or all). |
monitor.tracing.service |
"PKI" |
Trace service name. |
monitor.tracing.exporter |
"logging" |
Trace exporter (logging, otlp-grpc, otlp-http, jaeger, honeycomb, datadog). |
monitor.tracing.endpoint |
"http://otel-collector:4317" |
Exporter endpoint URL. |
monitor.tracing.compression |
gzip |
Export payload compression (gzip or none). |
monitor.tracing.timeout |
10000 |
Export timeout in milliseconds. |
monitor.tracing.sampler |
"always_on" |
Sampling strategy (always_on, always_off, or ratio:<value>). |
monitor.tracing.headers[].key |
"k1", "k2" |
Tracing exporter custom header key. |
monitor.tracing.headers[].value |
"v1", "v2" |
Tracing exporter custom header value. |