Skip to content

add option to skip the shaded protobuf and otel libraries #1293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zeitlinger merged 8 commits into from
Apr 15, 2025
Merged

add option to skip the shaded protobuf and otel libraries #1293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2bffe74
add option to skip the shaded protobuf libraries
zeitlinger Feb 28, 2025
40d5485
add option to skip the shaded protobuf libraries
zeitlinger Feb 28, 2025
963a393
add option to skip the shaded protobuf libraries
zeitlinger Feb 28, 2025
0532594
add option to skip the shaded otel libraries
zeitlinger Feb 28, 2025
6097793
update protobuf
zeitlinger Mar 6, 2025
3447ac6
fix rebase
zeitlinger Apr 15, 2025
e4dc0e3
update mise
zeitlinger Apr 15, 2025
525ee92
make shaded deps optional
zeitlinger Apr 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .github/workflows/acceptance-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,3 @@ jobs:
- uses: jdx/mise-action@v2
- name: Run acceptance tests
run: mise run acceptance-test
- name: upload log file
uses: actions/upload-artifact@v4
if: failure()
with:
name: OATs logs
path: build/**/*.log
80 changes: 70 additions & 10 deletions docs/content/exporters/formats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,74 @@ You can exclude the protobuf exposition format by including the
For example, in Maven:

```xml
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exporter-httpserver</artifactId>
<exclusions>
<exclusion>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exposition-formats</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependencies>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exporter-httpserver</artifactId>
<exclusions>
<exclusion>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exposition-formats</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exposition-textformats</artifactId>
</dependency>
</dependencies>
```

## Exclude the shaded protobuf classes

You can exclude the shaded protobuf classes including the
`prometheus-metrics-exposition-formats-no-protobuf` module and excluding the
`prometheus-metrics-exposition-formats` module in your build file.

For example, in Maven:

```xml
<dependencies>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exporter-httpserver</artifactId>
<exclusions>
<exclusion>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exposition-formats</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exposition-formats-no-protobuf</artifactId>
</dependency>
</dependencies>
```

## Exclude the shaded otel classes

You can exclude the shaded otel classes including the
`prometheus-metrics-exporter-opentelemetry-no-otel` module and excluding the
`prometheus-metrics-exporter-opentelemetry` module in your build file.

For example, in Maven:

```xml
<dependencies>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exporter-opentelemetry</artifactId>
<exclusions>
<exclusion>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exporter-opentelemetry</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exporter-opentelemetry-no-otel</artifactId>
</dependency>
</dependencies>
```
27 changes: 25 additions & 2 deletions integration-tests/it-spring-boot-smoke-test/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">

<modelVersion>4.0.0</modelVersion>
Expand All @@ -21,10 +22,18 @@
</description>
<properties>
<java.version>17</java.version>
<junit-jupiter.version>5.12.0</junit-jupiter.version>
</properties>

<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.junit</groupId>
<artifactId>junit-bom</artifactId>
<version>${junit-jupiter.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-bom</artifactId>
Expand All @@ -49,12 +58,26 @@
<artifactId>micrometer-registry-prometheus</artifactId>
<scope>runtime</scope>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-launcher</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>it-common</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion mise.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tools."go:github.com/grafana/oats"]
version = "0.2.0"
version = "0.3.0"
backend = "go:github.com/grafana/oats"

[tools.java]
Expand Down
2 changes: 1 addition & 1 deletion mise.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
PROTO_GENERATION = "true"

[tools]
"go:github.com/grafana/oats" = "0.2.0"
"go:github.com/grafana/oats" = "latest"
java = "temurin-17.0.13+11"
protoc = "latest"

Expand Down
3 changes: 3 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<automatic.module.name>--module-name-need-to-be-overriden--</automatic.module.name>
<protobuf-java.version>4.30.2</protobuf-java.version>
<guava.version>33.4.7-jre</guava.version>
<junit-jupiter.version>5.12.2</junit-jupiter.version>
<otel.instrumentation.version>2.15.0-alpha</otel.instrumentation.version>
Expand Down Expand Up @@ -68,12 +69,14 @@
<module>prometheus-metrics-model</module>
<module>prometheus-metrics-tracer</module>
<module>prometheus-metrics-exposition-formats</module>
<module>prometheus-metrics-exposition-formats-shaded</module>
<module>prometheus-metrics-exposition-textformats</module>
<module>prometheus-metrics-exporter-common</module>
<module>prometheus-metrics-exporter-servlet-jakarta</module>
<module>prometheus-metrics-exporter-servlet-javax</module>
<module>prometheus-metrics-exporter-httpserver</module>
<module>prometheus-metrics-exporter-opentelemetry</module>
<module>prometheus-metrics-exporter-opentelemetry-shaded</module>
<module>prometheus-metrics-exporter-opentelemetry-otel-agent-resources</module>
<module>prometheus-metrics-exporter-pushgateway</module>
<module>prometheus-metrics-instrumentation-caffeine</module>
Expand Down
10 changes: 10 additions & 0 deletions prometheus-metrics-bom/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,11 @@
<artifactId>prometheus-metrics-exporter-opentelemetry</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exporter-opentelemetry-no-otel</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exporter-pushgateway</artifactId>
Expand All @@ -62,6 +67,11 @@
<artifactId>prometheus-metrics-exporter-servlet-javax</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exposition-formats-no-protobuf</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exposition-formats</artifactId>
Expand Down
148 changes: 148 additions & 0 deletions prometheus-metrics-exporter-opentelemetry-shaded/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>io.prometheus</groupId>
<artifactId>client_java</artifactId>
<version>10.0.0-SNAPSHOT</version>
</parent>

<artifactId>prometheus-metrics-exporter-opentelemetry</artifactId>
<packaging>bundle</packaging>

<name>Prometheus Metrics to OpenTelemetry Exporter</name>
<description>
Converts Prometheus metrics to OpenTelemetry format and pushes them to an OTLP endpoint
</description>

<properties>
<automatic.module.name>io.prometheus.metrics.exporter.opentelemetry</automatic.module.name>
</properties>

<dependencies>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>prometheus-metrics-exporter-opentelemetry-no-otel</artifactId>
<version>${project.version}</version>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<executions>
<execution>
<id>regex-property</id>
<goals>
<goal>regex-property</goal>
</goals>
<configuration>
<name>otel.instrumentation.string-version</name>
<value>${otel.instrumentation.version}</value>
<regex>[\.-]</regex>
<replacement>_</replacement>
<failIfNoMatch>true</failIfNoMatch>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<artifactSet>
<includes>
<include>io.opentelemetry:*</include>
<include>io.opentelemetry.semconv:*</include>
<include>io.opentelemetry.instrumentation:*</include>
<include>com.squareup.*:*</include>
<include>org.jetbrains:*</include>
<include>org.jetbrains.*:*</include>
</includes>
</artifactSet>
<relocations>
<relocation>
<pattern>io.opentelemetry</pattern>
<shadedPattern>
io.prometheus.metrics.shaded.io_opentelemetry_${otel.instrumentation.string-version}
</shadedPattern>
</relocation>
<relocation>
<pattern>io.opentelemetry.instrumentation</pattern>
<shadedPattern>
io.prometheus.metrics.shaded.io_opentelemetry_${otel.instrumentation.string-version}.instrumentation
</shadedPattern>
</relocation>
<relocation>
<pattern>io.opentelemetry.semconv</pattern>
<shadedPattern>
io.prometheus.metrics.shaded.io_opentelemetry_${otel.instrumentation.string-version}.semconv
</shadedPattern>
</relocation>
<relocation>
<pattern>okhttp3</pattern>
<shadedPattern>
io.prometheus.metrics.shaded.io_opentelemetry_${otel.instrumentation.string-version}.okhttp3
</shadedPattern>
</relocation>
<relocation>
<pattern>kotlin</pattern>
<shadedPattern>
io.prometheus.metrics.shaded.io_opentelemetry_${otel.instrumentation.string-version}.kotlin
</shadedPattern>
</relocation>
<relocation>
<pattern>org.intellij</pattern>
<shadedPattern>
io.prometheus.metrics.shaded.io_opentelemetry_${otel.instrumentation.string-version}.org.intellij
</shadedPattern>
</relocation>
<relocation>
<pattern>org.jetbrains</pattern>
<shadedPattern>
io.prometheus.metrics.shaded.io_opentelemetry_${otel.instrumentation.string-version}.org.jetbrains
</shadedPattern>
</relocation>
<relocation>
<pattern>okio</pattern>
<shadedPattern>
io.prometheus.metrics.shaded.io_opentelemetry_${otel.instrumentation.string-version}.okio
</shadedPattern>
</relocation>
</relocations>
<transformers>
<transformer
implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
</transformers>
<filters>
<filter>
<artifact>*:*</artifact>
<excludes>
<exclude>lib/opentelemetry-*</exclude>
<exclude>META-INF/maven/org.jctools/**</exclude>
<exclude>META-INF/maven/org.jetbrains/**</exclude>
<exclude>META-INF/versions/**</exclude>
<exclude>META-INF/native-image/**</exclude>
<exclude>META-INF/proguard/**</exclude>
<exclude>META-INF/*.kotlin_module</exclude>
<exclude>META-INF/MANIFEST.MF</exclude>
</excludes>
</filter>
</filters>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
Loading
Loading