DigiWF Camunda Prometheus Exporter

The DigiWF Camunda Prometheus Exporter library exports Camunda Metrics for prometheus and allows to register own metric providers for digiwf.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
3. Usage
4. Contributing
5. License
6. Contact

Features

• Task Metrics: Metrics for assigned and unanssigned tasks
• Incident Metrics: Open Incidents
• Process Metrics: Deployed Definitions and Open Process Instances
• Job Metrics: Executable, suspended and future job metrics

Built With

This project is built with:

• Spring Boot
• Micrometer
• Inspired by Camunda Prometheus Exporter

Getting Started

Below is an example of how you can installing and setup up your service

1. Use the camunda initalizer and create a Spring Boot application with Web dependencies https://start.camunda.com/
2. Add the spring-boot-actuator and digiwf-camunda-prometheus dependency

With Maven:

  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-actuator</artifactId>
      <version>2.6.4</version>
  </dependency>

   <dependency>
        <groupId>io.muenchendigital.digiwf</groupId>
        <artifactId>digiwf-camunda-prometheus-starter</artifactId>
        <version>${digiwf.version}</version>
   </dependency>

With Gradle:

implementation group: 'io.muenchendigital.digiwf', name: 'digiwf-camunda-prometheus-starter', version: '${digiwf.version}'
implementation group: 'org.springframework.boot', name: 'spring-boot-starter-actuator', version: '2.6.4'

3. Add your own Metrics by implementing the MetricsProvider Interface

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

it@M - opensource@muenchen.de

Join our Slack Channel for more information!