Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/banzaicloud/prometheus-jmx-exporter-operator
https://github.com/banzaicloud/prometheus-jmx-exporter-operator
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/banzaicloud/prometheus-jmx-exporter-operator
- Owner: banzaicloud
- License: apache-2.0
- Created: 2018-04-20T11:25:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-02T08:01:02.000Z (about 4 years ago)
- Last Synced: 2024-05-22T14:31:40.943Z (6 months ago)
- Language: Go
- Size: 23.2 MB
- Stars: 45
- Watchers: 6
- Forks: 17
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Prometheus Jmx Exporter Operator
This operator using [Jmx Exporter](https://github.com/prometheus/jmx_exporter) enables Java processes running ok Kubernetes Pods to expose metrics collected form mBeans via JMX to Prometheus.
## Usage
### Prometheus JMX Exporter Configuration
#### Create a [configuration](https://github.com/prometheus/jmx_exporter#configuration) file for the JMX Exporter.
*Note* that in our case `hostPort` and `jmxUrl` should not be set as the Jmx Exporter agent will be loaded into the Java process and we want it to talk to the local JVM. More configuration examples of Prometheus JMX Exporter can be found [here](https://github.com/prometheus/jmx_exporter/tree/master/example_configs)
#### Add to configuration to a Kubernetes [config map](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/)
```kubectl create cm --from-file=```
e.g.:
```sh
kubectl create cm prometheus-jmx-exporter-config --from-file=javadummy/config.yaml
kubectl describe cm prometheus-jmx-exporter-config
```
#### RBAC
If [RBAC](https://kubernetes.io/docs/admin/authorization/rbac/) is enabled in your Kubernetes cluster than a [service account](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) is needed to be created with the approprite role binding for the operator.
Download the [rbac.yaml](https://github.com/banzaicloud/prometheus-jmx-exporter-operator/blob/master/deploy/rbac.yaml) file then execute:
```sh
kubectl create -f
```
#### Deploy the operator to Kubernetes
Download the [operator.yaml](https://github.com/banzaicloud/prometheus-jmx-exporter-operator/blob/master/deploy/operator.yaml) deployment file. If you don't have RBAC enabled than remove
```
serviceAccountName: prometheus-jmx-exporter-operator
```
```sh
kubectl create -f
```
#### Create `prometheus-jmx-exporter` resources
Download [cr.yaml](https://github.com/banzaicloud/prometheus-jmx-exporter-operator/blob/master/deploy/cr.yaml) and customize it for your needs.
```
spec:
labelSelector:
app: dummyapp
```
The label selector specifies what pods the operator to watch. The operator will investigate the pods that have labels which matches what is specified in `labelSelector`.
It checks the containers of the pod and the Java applications running in these containers.
It will load the Prometheus JMX Exporter into the Java applications and passes to it the configuration from the config map.
```
config:
configMapName: prometheus-jmx-exporter-config
configMapKey: config.yaml
```
Note: see [Prometheus JMX Exporter Configuration](#prometheus_jmx_exporter_configuration) above
```
port: 9400
```
This is the port number at which Prometheus server can scrape the metrics exported by Prometheus JMX exporter.
Chose a port that is not conflicting with any of the container ports already used by the applications running in the containers.
#### List the JMX Exporter endpoints managed by the operator
```
kubectl get prometheusjmxexporter
kubectl get prometheusjmxexporter -o yaml
```
The `status` section lists the endpoints.
## Limitations
Currently only one Java process per pod is being supported. In case a pod has multiple containers than the operator will select the first container from the list of containers
returned by Kubernetes API. Also if a container has multiple java processes running than the operator works on the first process.
## Future work
* Currently the user is required to provide a port for the Prometheus JMX Exporter that doesn't conflict with ports already being used
by processes running on the pod. The operator should take care of this by choosing a free port available in the container.
* Investigate the possibility of supporting pods with multiple containers and multiple Java processes per container.
This operator best works with microservices where there is one process per container.