Skip to content

Commit 259e6cc

Browse files
Linu-Eliasalaudazziishleenk17
authored
[Jolokia Input] Update Documentation (elastic#14792)
* update readme * add readme * add changelog * add manifest * Edit the integration readme * Update packages/jolokia_input/docs/README.md Co-authored-by: Ishleen Kaur <102962586+ishleenk17@users.noreply.github.com> --------- Co-authored-by: Arianna Laudazzi <arianna.laudazzi@elastic.co> Co-authored-by: Ishleen Kaur <102962586+ishleenk17@users.noreply.github.com>
1 parent 50b6b4f commit 259e6cc

3 files changed

Lines changed: 64 additions & 4 deletions

File tree

packages/jolokia_input/changelog.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# newer versions go on top
2+
- version: "0.8.0"
3+
changes:
4+
- description: Update `Readme` file.
5+
type: enhancement
6+
link: https://github.com/elastic/integrations/pull/14792
27
- version: "0.7.2"
38
changes:
49
- description: Update `metrics_path` to `path`.
Lines changed: 58 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,66 @@
11
# Jolokia input
22

3-
This input package collects metrics from [Jolokia agents](https://jolokia.org/agent.html) running on a target JMX server or dedicated proxy server.
3+
The Jolokia input package collects metrics from [Jolokia agents](https://jolokia.org/agent.html) running on a target JMX server or dedicated proxy server.
44

55
The metrics are collected by communicating with a Jolokia HTTP/REST endpoint that exposes the JMX metrics over HTTP/REST/JSON.
66

7-
The user can use this input for any service that collects metrics through Jolokia endpoint. User has the flexibility to provide custom mappings and custom ingets pipelines through the Kibana UI to get the tailored data.
7+
You can use this input for any service that collects metrics through Jolokia endpoint. You can provide custom mappings and custom ingets pipelines through the Kibana UI to get the tailored data.
88

99
## Compatibility
1010

11-
The Jolokia module is tested with Jolokia 1.7.0.
11+
The Jolokia module is tested with Jolokia 2.2.9.
12+
13+
## Configuration
14+
15+
### Hosts
16+
To collect metrics from a Jolokia endpoint, configure the hosts setting to point to your Jolokia agent.
17+
For example:
18+
`http://host_address:jolokia_port`
19+
20+
### Period
21+
Defines the interval at which metrics are fetched.
22+
For example, every `1s`, `1m`, `1h`.
23+
24+
### Path
25+
Specifies the endpoint path of the Jolokia service, including any optional query parameters.
26+
- Default: `/jolokia`
27+
- Example with query parameters:: `/jolokia/?ignoreErrors=true&canonicalNaming=false`
28+
29+
### HTTP Method
30+
Specifies the HTTP method used to communicate with the Jolokia endpoint.
31+
- Supported values: `GET`, `POST`
32+
33+
### Authentication and SSL Configuration
34+
To securely communicate with HTTPS-enabled Jolokia endpoints, you can configure `SSL settings` to meet the necessary requirements. For example:
35+
36+
```yaml
37+
ssl.verification_mode: full # Options: none, certificate, full
38+
ssl.certificate_authorities:
39+
- /etc/ssl/certs/ca.crt # Path to trusted CA file(s)
40+
ssl.certificate: /etc/ssl/certs/client.crt # Client certificate for mTLS
41+
ssl.key: /etc/ssl/private/client.key # Private key for the client certificate
42+
ssl.key_passphrase: your_key_passphrase # Optional: if the private key is encrypted
43+
ssl.ca_trusted_fingerprint: "AB:CD:EF:..." # Optional: pin to a trusted CA fingerprint
44+
bearer_token_file: /path/to/token.txt # Optional: for token-based auth
45+
username: your_username # Optional: for basic auth
46+
password: your_password # Optional: for basic auth
47+
48+
```
49+
- `username / password` used for Basic authentication (if required by Jolokia).
50+
51+
52+
### JMX Mappings and attributes
53+
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 show in below example:
54+
55+
```
56+
- mbean: 'java.lang:type=Runtime'
57+
attributes:
58+
- attr: Uptime
59+
field: uptime
60+
- mbean: 'java.lang:type=Memory'
61+
attributes:
62+
- attr: HeapMemoryUsage
63+
field: memory.heap_usage
64+
- attr: NonHeapMemoryUsage
65+
field: memory.non_heap_usage
66+
```

packages/jolokia_input/manifest.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
format_version: "3.0.0"
22
name: jolokia
33
title: "Jolokia Input"
4-
version: "0.7.2"
4+
version: "0.8.0"
55
description: "Collects Metrics from Jolokia Agents"
66
type: input
77
categories:

0 commit comments

Comments
 (0)