Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

Camunda Carbon Reductor

Allows you to time shift your processes' carbon emissions when energy is clean while still fulfilling the requested service level agreement.
https://github.com/envite-consulting/camunda-carbon-reductor

Category: Consumption
Sub Category: Computation and Communication

Keywords

bpmn camunda camunda-platform-8 connector green-it sustainability

Keywords from Contributors

bpm camunda-bpm-platform camunda-engine cmmn dmn process-engine

Last synced: about 17 hours ago
JSON representation

Repository metadata

The Camunda Carbon Reductor allows you to time shift your processes' carbon emissions when energy is clean while still fulfilling the requested SLAs.

README.md

🌱Camunda Carbon Reductor

The Camunda Carbon Reductor allows you to time shift your processes' carbon emissions when energy is clean while still fulfilling the requested SLAs.

Technically, it's implemented as a Camunda Connector for Camunda Platform 8 and as an External Task Worker for Camunda Platform 7.

You want to contribute 🌱? Please read the Contribution Guidelines.

Table of Contents

✨Features

The Carbon Reductor Connector consists of an element-template that can be used in the process
model that connects to the connector function.

Time Shifting Mode ⏭️

Using the time shifting mode (default) the Carbon Reductor Connector allows you to
optimize for lower carbon emissions by moving your process execution into a timeframe with the least amount
of carbon possible while still fulfilling SLAs.

The Carbon Reductor Connector defines the following inputs:

  • the location where the worker are running (e.g. Germany, UK, France, USA, etc.)
  • a milestone (a timestamp used to calculate the duration the process instance has been running)
  • a duration for the remainder of the process (the duration the remainder needs at most)
  • the maximum duration a process instance can take
  • optionally, set a threshold for the minimum amount of grams of CO2 per kilowatt-hour that should be saved

Measuring Mode 📏

Note: This mode only works with the Carbon Aware SDK API at the moment.

Using the measuring mode the Carbon Reductor Connector allows you to measure the emissions in gCO2e/KWh at
execution time and reports as well the emissions at the optimal time while still fulfilling your SLAs.

The same input as in the Time Shifting Mode ⏭️ is required.

🚀Getting Started

We provide the Carbon Reductor for Camunda Platform 7 and 8:

Camunda 8

To start the Camunda 8 Connector have a look at the specific README.

Camunda 7

To start the Camunda 7 External Task Worker have a look at the specific README.

📈Reporting Carbon Reduction via Camunda Optimize

Since Camunda Carbon Reductor stores the carbon savings as process variables,
we have the ability to visualize our successes in Camunda Optimize.

For the CarbonHack22
we visualized the results for out example process and it looks like the following:

CarbonHack22 Dashboard

The exported Dashboard Definition could be found here.

🏗Building Blocks

Building Block View Level 0 Camunda Carbon Reductor

Element Description
Carbon Reductor Core Core module which calculates the possible time shifting based on data it fetches from the external systems.
Carbon Aware API Custom Client to connect to the Carbon Aware SDK.
Carbon Aware Computing API Custom Client to connect to the Carbon Aware Computing API.
Camunda Carbon Reductor C8 Camunda 8 Job Worker.
Camunda Carbon Reductor C7 Camunda 7 External Task Worker.

📚Releases

The list of releases contains a detailed changelog.

We use Semantic Versioning.

The following compatibility matrix shows the officially supported Camunda versions for each release.
Other combinations might also work but have not been tested.

Release Camunda Platform 8 Camunda Platform 7
2.1.4 8.5.0 7.21.0
2.1.5 8.6.0 7.22.0
2.1.6 8.7.0 7.23.0
Release Camunda Platform 8 Camunda Platform 7
1.0.0 8.1.0 7.18.0
1.1.0 8.2.0 7.19.0
2.0.0 8.2.3 7.19.0
2.0.1 8.2.3 7.19.0
2.0.2 8.2.3 7.19.0
2.0.3 8.3.0 7.19.0
2.1.0 8.3.0 7.20.0
2.1.1 8.4.0 7.20.0
2.1.2 8.5.0 7.21.0
2.1.3 8.5.0 7.21.0
2.1.4 8.5.0 7.21.0
2.1.5 8.6.0 7.22.0
2.1.6 8.7.0 7.23.0

Download of Releases:

📆Publications

If you are interested in our work and want to get to know more, feel free to reach out to us.

📨Contact

If you have any questions or ideas feel free to start a discussion or contact us via mail.

This open source project is being developed by envite consulting GmbH.

envite consulting GmbH
envite consulting GmbH

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 217
Total Committers: 9
Avg Commits per committer: 24.111
Development Distribution Score (DDS): 0.585

Commits in past year: 43
Committers in past year: 6
Avg Commits per committer in past year: 7.167
Development Distribution Score (DDS) in past year: 0.651

Name Email Commits
Luc Weinbrecht l****c@w****e 90
Maximilian Behrendt m****t@e****e 74
ReleaseAction[bot] a****s@g****m 22
Tobias Schaefer t****r@e****e 15
Philipp Hehnle p****e@e****e 11
Philipp Hehnle p****e@g****m 2
Henning Krause h****e@e****e 1
Sebastian Gülpen s****n@M****x 1
Sebastian Guelpen s****n@s****e 1

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 19
Total pull requests: 116
Average time to close issues: about 1 month
Average time to close pull requests: 8 days
Total issue authors: 4
Total pull request authors: 6
Average comments per issue: 0.42
Average comments per pull request: 0.1
Merged pull request: 103
Bot issues: 0
Bot pull requests: 0

Past year issues: 6
Past year pull requests: 23
Past year average time to close issues: 1 day
Past year average time to close pull requests: 5 days
Past year issue authors: 1
Past year pull request authors: 4
Past year average comments per issue: 0.17
Past year average comments per pull request: 0.26
Past year merged pull request: 19
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/envite-consulting/camunda-carbon-reductor

Top Issue Authors

  • lwluc (13)
  • maxbehr801 (4)
  • RodrigoCarlstrom (1)
  • tobiasschaefer (1)

Top Pull Request Authors

  • lwluc (55)
  • maxbehr801 (42)
  • tobiasschaefer (10)
  • hehnle (6)
  • options-a11y (2)
  • henningkrause95 (1)

Top Issue Labels

  • enhancement (10)
  • bug (5)
  • good first issue (4)
  • refactoring (4)
  • documentation (2)

Top Pull Request Labels

  • documentation (1)

Dependencies

.github/workflows/build-and-upload.yml actions
  • actions/checkout v1 composite
  • docker/login-action v2 composite
.github/workflows/continuous-integration.yml actions
  • actions/checkout v3 composite
  • actions/setup-java v3 composite
camunda-carbon-reductor-c7/Dockerfile docker
  • maven 3.8.3-openjdk-17 build
  • openjdk 17.0.1-jdk-slim build
camunda-carbon-reductor-c8/Dockerfile docker
  • maven 3.8.3-openjdk-17 build
  • openjdk 17.0.1-jdk-slim build
camunda-carbon-reductor-c7/pom.xml maven
  • org.springframework.boot:spring-boot-dependencies 2.7.3 import
  • com.sun.xml.bind:jaxb-impl 2.3.5
  • de.envite.greenbpm:carbon-reductor-core 1.0.2-SNAPSHOT
  • joda-time:joda-time 2.12.2
  • org.camunda.bpm.springboot:camunda-bpm-spring-boot-starter-external-task-client 7.18.0
  • org.projectlombok:lombok ${version.lombok}
  • org.slf4j:slf4j-api ${version.slf4j}
  • org.springframework.boot:spring-boot
  • org.springframework.boot:spring-boot-autoconfigure
  • com.h2database:h2 test
  • org.assertj:assertj-core ${version.assertj} test
  • org.camunda.bpm.springboot:camunda-bpm-spring-boot-starter-test 7.18.0 test
  • org.camunda.bpm:camunda-bpm-junit5 7.18.0 test
  • org.camunda.bpm:camunda-engine 7.18.0 test
  • org.junit.jupiter:junit-jupiter ${version.junit-jupiter} test
camunda-carbon-reductor-c8/pom.xml maven
  • de.envite.greenbpm:carbon-reductor-core 1.0.2-SNAPSHOT
  • io.camunda.connector:connector-validation ${version.connector-core}
  • io.camunda:spring-zeebe-starter ${version.spring-zeebe-starter}
  • jakarta.validation:jakarta.validation-api ${version.jakarta.validation-api}
  • org.hibernate.validator:hibernate-validator ${version.hibernate-validator}
  • org.projectlombok:lombok ${version.lombok}
  • org.slf4j:slf4j-api ${version.slf4j}
  • io.camunda:zeebe-process-test-extension ${version.spring-zeebe-starter} test
  • org.assertj:assertj-core ${version.assertj} test
  • org.junit.jupiter:junit-jupiter ${version.junit-jupiter} test
  • org.mockito:mockito-junit-jupiter ${version.mockito} test
  • org.springframework.boot:spring-boot-starter-test test
carbon-reductor-core/pom.xml maven
  • de.envite.greenbpm:api-carbon-aware 1.0.2-SNAPSHOT
  • io.github.domain-primitives:domainprimitives-java ${version.domainprimitives}
  • org.projectlombok:lombok ${version.lombok}
  • org.slf4j:slf4j-api ${version.slf4j}
  • org.springframework:spring-context
  • org.assertj:assertj-core ${version.assertj} test
  • org.junit.jupiter:junit-jupiter ${version.junit-jupiter} test
  • org.mockito:mockito-junit-jupiter ${version.mockito} test
.github/workflows/release.yml actions
  • actions/checkout v3 composite
  • actions/setup-java v3 composite
api/api-carbon-aware/pom.xml maven
api/api-carbon-aware-computing/pom.xml maven
api/pom.xml maven
  • javax:javaee-web-api 8.0.1 provided
  • com.google.code.findbugs:jsr305 3.0.2
  • com.google.code.gson:gson 2.10.1
  • com.squareup.okhttp3:logging-interceptor 4.11.0
  • com.squareup.okhttp3:okhttp 4.11.0
  • com.squareup.okio:okio 3.4.0
  • io.gsonfire:gson-fire 1.8.5
  • io.swagger.core.v3:swagger-annotations 2.2.9
  • io.swagger:swagger-annotations 1.6.10
  • org.openapitools:jackson-databind-nullable 0.2.6
pom.xml maven

Score: 5.564520407322694