Jolokia input
Version | 1.0.0 (View all) |
Compatible Kibana version(s) | 8.17.0 or higher 9.0.0 or higher |
Supported Serverless project types What's this? |
Security Observability |
Subscription level What's this? |
Basic |
Level of support What's this? |
Elastic |
The Jolokia input package collects metrics from Jolokia agents running on a target JMX server or dedicated proxy server.
The metrics are collected by communicating with a Jolokia HTTP/REST endpoint that exposes the JMX metrics over HTTP/REST/JSON.
You can use this input for any service that collects metrics through Jolokia endpoint. Optionally, you can provide custom mappings and custom ingest pipelines through the Kibana UI to get the tailored data.
The Jolokia module is tested with Jolokia 2.2.9.
To collect metrics from a Jolokia endpoint, configure the hosts setting to point to your Jolokia agent.
For example:
http://host_address:jolokia_port
Defines the interval at which metrics are fetched.
For example, every 1s
, 1m
, 1h
.
Specifies the endpoint path of the Jolokia service, including any optional query parameters.
- Default:
/jolokia
- Example with query parameters::
/jolokia/?ignoreErrors=true&canonicalNaming=false
Specifies the HTTP method used to communicate with the Jolokia endpoint.
- Supported values:
GET
,POST
To securely communicate with HTTPS-enabled Jolokia endpoints, you can configure SSL settings
to meet the necessary requirements. For example:
ssl.verification_mode: full
ssl.certificate_authorities:
- /etc/ssl/certs/ca.crt
ssl.certificate: /etc/ssl/certs/client.crt
ssl.key: /etc/ssl/private/client.key
ssl.key_passphrase: your_key_passphrase
ssl.ca_trusted_fingerprint: "AB:CD:EF:..."
bearer_token_file: /path/to/token.txt
username: your_username
password: your_password
username / password
used for Basic authentication (if required by Jolokia).
The Jolokia input package can collect metrics from various JMX MBeans by configuring the mbean
parameter. You can specify which MBeans and attributes to collect as shown in the example below.
- mbean: 'java.lang:type=Runtime'
attributes:
- attr: Uptime
field: uptime
- mbean: 'java.lang:type=Memory'
attributes:
- attr: HeapMemoryUsage
field: memory.heap_usage
- attr: NonHeapMemoryUsage
field: memory.non_heap_usage
Changelog
Version | Details | Kibana version(s) |
---|---|---|
1.0.0 | Enhancement (View pull request) Make Jolokia Input GA |
8.17.0 or higher 9.0.0 or higher |
0.8.1 | Bug fix (View pull request) fix Readme file. |
— |
0.8.0 | Enhancement (View pull request) Update Readme file. |
— |
0.7.2 | Bug fix (View pull request) Update metrics_path to path . |
— |
0.7.1 | Bug fix (View pull request) Added description to ssl nodes to package level manifest.yml file to including links to documentation. |
— |
0.7.0 | Enhancement (View pull request) Add support for Kibana 9.0.0 . |
— |
0.6.1 | Enhancement (View pull request) Add missing category. |
— |
0.6.0 | Enhancement (View pull request) Added HTTP Options and http_method parameter (default to GET). |
— |
0.5.0 | Enhancement (View pull request) ECS version updated to 8.11.0. Update the kibana constraint to ^8.13.0. Modified the field definitions to remove ECS fields made redundant by the ecs@mappings component template. |
— |
0.4.0 | Enhancement (View pull request) Add processors option. |
— |
0.3.0 | Enhancement (View pull request) Update the package format_version to 3.0.0. |
— |
0.2.0 | Enhancement (View pull request) Update the Kibana Version to 8.8.0 |
— |
0.1.0 | Enhancement (View pull request) Rename ownership from obs-service-integrations to obs-infraobs-integrations |
— |
0.0.5 | Bug fix (View pull request) Added build manifest to indicate the ECS reference. |
— |
0.0.4 | Enhancement (View pull request) Added categories and/or subcategories. |
— |
0.0.3 | Bug fix (View pull request) Update the Jolokia metrics path |
— |
0.0.2 | Enhancement (View pull request) Update the Jolokia logo |
— |
0.0.1 | Enhancement (View pull request) Initial draft of the Jolokia Input |
— |