├── .github └── workflows │ ├── release.yml │ └── test.yml ├── .gitignore ├── LICENSE ├── Makefile ├── README.md ├── build.gradle ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat └── src ├── main ├── java │ └── io │ │ └── otel │ │ └── pyroscope │ │ ├── OtelCompat.java │ │ ├── OtelProfilerSdkBridge.java │ │ ├── PyroscopeOtelAutoConfigurationCustomizerProvider.java │ │ ├── PyroscopeOtelConfiguration.java │ │ └── PyroscopeOtelSpanProcessor.java └── resources │ └── META-INF │ └── services │ └── io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider └── test └── java └── io └── otel └── pyroscope └── PyroscopeOtelSpanProcessorTest.java /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | 3 | on: 4 | workflow_dispatch: 5 | inputs: 6 | version_bump: 7 | description: 'Version Bump Type' 8 | required: true 9 | default: 'minor' 10 | type: choice 11 | options: 12 | - patch 13 | - minor 14 | - major 15 | 16 | permissions: 17 | contents: write 18 | packages: write 19 | id-token: write 20 | 21 | jobs: 22 | release: 23 | runs-on: ubuntu-latest 24 | steps: 25 | - name: Get secrets 26 | uses: grafana/shared-workflows/actions/get-vault-secrets@8fa210559ab2cc62e7b12d3bb9cba19dbc862c11 27 | with: 28 | repo_secrets: | 29 | NEXUS_USERNAME=publishing:nexus_username 30 | NEXUS_PASSWORD=publishing:nexus_password 31 | NEXUS_GPG_KEY_ID=publishing:nexus_gpg_key_id 32 | NEXUS_GPG_PASSWORD=publishing:nexus_gpg_password 33 | NEXUS_GPG_SECRING_FILE_BASE64=publishing:nexus_gpg_secring_file 34 | GITHUB_APP_ID=pyroscope-development-app:app-id 35 | GITHUB_APP_PRIVATE_KEY=pyroscope-development-app:app-private-key 36 | 37 | - name: Generate GitHub token 38 | uses: actions/create-github-app-token@v1 39 | id: app-token 40 | with: 41 | app-id: ${{ env.GITHUB_APP_ID }} 42 | private-key: ${{ env.GITHUB_APP_PRIVATE_KEY }} 43 | 44 | - name: Checkout code 45 | uses: actions/checkout@v4 46 | with: 47 | token: ${{ steps.app-token.outputs.token }} 48 | persist-credentials: true # push the tag later 49 | 50 | - name: Set up Java 8 51 | uses: actions/setup-java@v4 52 | with: 53 | java-version: '8' 54 | distribution: 'temurin' 55 | 56 | - name: Bump Version 57 | id: bump_version 58 | env: 59 | VERSION_BUMP: ${{ inputs.version_bump }} 60 | run: | 61 | current_version=$(grep 'otel_profiling_version=' gradle.properties | cut -d'=' -f2) 62 | echo "Current version: $current_version" 63 | IFS='.' read -r major minor patch <<< "$current_version" 64 | 65 | case "$VERSION_BUMP" in 66 | "major") 67 | major=$((major + 1)) 68 | minor=0 69 | patch=0 70 | ;; 71 | "minor") 72 | minor=$((minor + 1)) 73 | patch=0 74 | ;; 75 | "patch") 76 | patch=$((patch + 1)) 77 | ;; 78 | esac 79 | 80 | new_version="${major}.${minor}.${patch}" 81 | echo "New version: $new_version" 82 | 83 | sed -i "s/otel_profiling_version=.*/otel_profiling_version=$new_version/" gradle.properties 84 | echo "version=$new_version" >> $GITHUB_OUTPUT 85 | 86 | - name: Prepare GPG Keyring 87 | id: prepare_gpg_keyring 88 | run: | 89 | mkdir -p ${{ github.workspace }}/gpg 90 | echo "$NEXUS_GPG_SECRING_FILE_BASE64" | base64 -d > ${{ github.workspace }}/gpg/secring.gpg 91 | chmod 600 ${{ github.workspace }}/gpg/secring.gpg 92 | echo "keyring_path=${{ github.workspace }}/gpg/secring.gpg" >> $GITHUB_OUTPUT 93 | 94 | - name: Build and Publish 95 | run: | 96 | export NEXUS_GPG_SECRING_FILE=${{ steps.prepare_gpg_keyring.outputs.keyring_path }} 97 | make publish 98 | 99 | - name: Get GitHub App User ID 100 | id: get-user-id 101 | run: echo "user-id=$(gh api "/users/${{ steps.app-token.outputs.app-slug }}[bot]" --jq .id)" >> "$GITHUB_OUTPUT" 102 | env: 103 | GITHUB_TOKEN: ${{ steps.app-token.outputs.token }} 104 | 105 | - name: Commit Version Bump 106 | run: | 107 | git config --global user.name '${{ steps.app-token.outputs.app-slug }}[bot]' 108 | git config --global user.email '${{ steps.get-user-id.outputs.user-id }}+${{ steps.app-token.outputs.app-slug }}[bot]@users.noreply.github.com' 109 | git add gradle.properties 110 | git commit -m "version ${{ steps.bump_version.outputs.version }}" 111 | git tag "v${{ steps.bump_version.outputs.version }}" 112 | git push --atomic origin "refs/heads/main" "refs/tags/v${{ steps.bump_version.outputs.version }}" 113 | env: 114 | GITHUB_TOKEN: ${{ steps.app-token.outputs.token }} 115 | 116 | - name: Create GitHub Release 117 | run: | 118 | gh release create "v${{ steps.bump_version.outputs.version }}" \ 119 | build/libs/pyroscope-otel.jar \ 120 | --title "Release v${{ steps.bump_version.outputs.version }}" \ 121 | --notes "Automated release" 122 | env: 123 | GITHUB_TOKEN: ${{ steps.app-token.outputs.token }} 124 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: 4 | push: 5 | branches: [main] 6 | pull_request: 7 | branches: [main] 8 | 9 | permissions: 10 | contents: read 11 | 12 | jobs: 13 | test: 14 | runs-on: ${{ matrix.os }} 15 | strategy: 16 | fail-fast: false 17 | matrix: 18 | os: [github-hosted-ubuntu-x64-small , macos-latest] 19 | java: ['8', '11', '17', '21'] 20 | steps: 21 | - uses: actions/checkout@v2 22 | with: 23 | persist-credentials: false 24 | - name: Set up JDK 25 | uses: actions/setup-java@v4 26 | with: 27 | java-version: ${{ matrix.java }} 28 | distribution: 'zulu' 29 | - run: ./gradlew test --stacktrace 30 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.idea/ 2 | 3 | # Ignore Gradle project-specific cache directory 4 | .gradle 5 | 6 | # Ignore Gradle build output directory 7 | build 8 | 9 | # Compiled class file 10 | *.class 11 | 12 | # Log file 13 | *.log 14 | 15 | # BlueJ files 16 | *.ctxt 17 | 18 | # Mobile Tools for Java (J2ME) 19 | .mtj.tmp/ 20 | 21 | # Package Files # 22 | *.jar 23 | *.war 24 | *.nar 25 | *.ear 26 | *.zip 27 | *.tar.gz 28 | *.rar 29 | 30 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 31 | hs_err_pid* 32 | 33 | .settings 34 | .project 35 | .classpath 36 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2023 Pyroscope, Inc 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: clean 2 | clean: 3 | ./gradlew clean 4 | 5 | .PHONY: build 6 | build: 7 | ./gradlew shadowJar 8 | 9 | .PHONY: publish 10 | publish: 11 | @echo "./gradlew clean assemble publishToSonatype closeAndReleaseSonatypeStagingRepository" 12 | @./gradlew clean assemble publishToSonatype closeAndReleaseSonatypeStagingRepository \ 13 | -PsonatypeUsername="$(NEXUS_USERNAME)" \ 14 | -PsonatypePassword="$(NEXUS_PASSWORD)" \ 15 | -Psigning.secretKeyRingFile="$(NEXUS_GPG_SECRING_FILE)" \ 16 | -Psigning.password="$(NEXUS_GPG_PASSWORD)" \ 17 | -Psigning.keyId="$(NEXUS_GPG_KEY_ID)" --stacktrace 18 | 19 | 20 | .PHONY: test 21 | test: 22 | ./gradlew test 23 | 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Java OpenTelemetry tracing integration 2 | 3 | Pyroscope can integrate with distributed tracing systems supporting [**OpenTelemetry**](https://opentelemetry.io/docs/instrumentation/java/getting-started/) standard which allows you to 4 | link traces with the profiling data, and find specific lines of code related to a performance issue. 5 | 6 | 7 | * Because of how sampling profilers work, spans shorter than the sample interval may not be captured. By default pyroscope CPU profiler probes stack traces 100 times per second, meaning that spans shorter than 10ms may not be captured. 8 | 9 | 10 | Java code can be easily instrumented with otel-profiling-java package - 11 | a `OpenTelemetry` implementation, that annotates profiling data with span IDs which makes it possible to filter 12 | out profile of a particular trace span in Pyroscope. 13 | 14 | Visit [docs](https://grafana.com/docs/pyroscope/latest/configure-client/trace-span-profiles/java-span-profiles/) page for usage and configuration documentation. 15 | 16 | ## Examples 17 | 18 | Check out the [examples](https://github.com/grafana/pyroscope/tree/main/examples/tracing/tempo) directory in our repository to 19 | find a complete example application that demonstrates tracing integration features and learn more 🔥 20 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'java-library' 3 | id 'maven-publish' 4 | id 'signing' 5 | id 'io.github.gradle-nexus.publish-plugin' version '1.1.0' 6 | id "com.github.johnrengelman.shadow" version "7.1.2" 7 | } 8 | 9 | 10 | ext { 11 | versions = [ 12 | opentelemetry : "1.17.0", 13 | opentelemetryJavaagentAlpha: "1.17.0-alpha", 14 | ] 15 | 16 | deps = [ 17 | autoservice: dependencies.create(group: 'com.google.auto.service', name: 'auto-service', version: '1.0.1') 18 | ] 19 | } 20 | 21 | def pyroscopeVersion = project.properties['pyroscope_version'] 22 | def otelProfilingVersion = project.properties['otel_profiling_version'] 23 | group = "io.pyroscope" 24 | version = otelProfilingVersion 25 | 26 | nexusPublishing { 27 | repositories { 28 | sonatype { //only for users registered in Sonatype after 24 Feb 2021 29 | nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/")) 30 | snapshotRepositoryUrl.set(uri("https://s01.oss.sonatype.org/content/repositories/snapshots/")) 31 | } 32 | } 33 | } 34 | 35 | sourceCompatibility = JavaVersion.VERSION_1_8 36 | targetCompatibility = JavaVersion.VERSION_1_8 37 | 38 | repositories { 39 | mavenCentral() 40 | } 41 | 42 | 43 | dependencies { 44 | implementation("io.pyroscope:agent:$pyroscopeVersion") 45 | 46 | compileOnly("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi:${versions.opentelemetry}") 47 | compileOnly("io.opentelemetry.instrumentation:opentelemetry-instrumentation-api:${versions.opentelemetryJavaagentAlpha}") 48 | compileOnly("io.opentelemetry.javaagent:opentelemetry-javaagent-extension-api:${versions.opentelemetryJavaagentAlpha}") 49 | 50 | testImplementation("io.opentelemetry:opentelemetry-sdk:${versions.opentelemetry}") 51 | testImplementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi:${versions.opentelemetry}") 52 | testImplementation("io.opentelemetry.instrumentation:opentelemetry-instrumentation-api:${versions.opentelemetryJavaagentAlpha}") 53 | testImplementation("io.opentelemetry.javaagent:opentelemetry-javaagent-extension-api:${versions.opentelemetryJavaagentAlpha}") 54 | 55 | testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.7.2' 56 | testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.7.2' 57 | testImplementation group: 'org.mockito', name: 'mockito-core', version: '3.10.0' 58 | testImplementation group: 'org.mockito', name: 'mockito-junit-jupiter', version: '3.10.0' 59 | } 60 | 61 | test { 62 | useJUnitPlatform() 63 | testLogging { 64 | events "passed", "skipped", "failed" 65 | } 66 | } 67 | 68 | java { 69 | withJavadocJar() 70 | withSourcesJar() 71 | } 72 | 73 | jar { 74 | 75 | } 76 | 77 | shadowJar { 78 | archiveFileName = "pyroscope-otel.jar" 79 | relocate("io.pyroscope", "io.otel.pyroscope.shadow") { 80 | exclude 'io.pyroscope.javaagent.ProfilerSdk' 81 | } 82 | archiveClassifier.set('') 83 | } 84 | 85 | publishing { 86 | publications { 87 | mavenJava(MavenPublication) { publication -> 88 | project.shadow.component(publication) 89 | groupId = 'io.pyroscope' 90 | artifactId = 'otel' 91 | version = otelProfilingVersion 92 | artifacts = [ shadowJar, javadocJar, sourcesJar ] 93 | pom { 94 | name = 'Pyroscope OTEL integration' 95 | description = 'Pyroscope OTEL integration' 96 | url = 'https://pyroscope.io' 97 | licenses { 98 | license { 99 | name = 'The Apache License, Version 2.0' 100 | url = 'http://www.apache.org/licenses/LICENSE-2.0.txt' 101 | } 102 | } 103 | developers { 104 | developer { 105 | id = 'pyroscope' 106 | name = 'Pyroscope' 107 | email = 'anatoly@pyroscope.io' 108 | } 109 | } 110 | scm { 111 | connection = 'scm:git:git://github.com/pyroscope-io/pyroscope-java.git' 112 | developerConnection = 'scm:git:ssh://github.com/pyroscope-io/pyroscope-java.git' 113 | url = 'https://github.com/pyroscope-io/pyroscope-java' 114 | } 115 | } 116 | } 117 | } 118 | repositories { 119 | maven { 120 | credentials { 121 | username project.hasProperty('nexusUsername') ? project.nexusUsername : '' 122 | password project.hasProperty('nexusPassword') ? project.nexusPassword : '' 123 | } 124 | url "https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/" 125 | } 126 | } 127 | } 128 | 129 | signing { 130 | sign publishing.publications.mavenJava 131 | } 132 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | pyroscope_version=2.0.0 2 | otel_profiling_version=1.0.4 3 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grafana/otel-profiling-java/f1dc2f648d1736d3cd10f59c19dcad36e1f579e5/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 84 | 85 | APP_NAME="Gradle" 86 | APP_BASE_NAME=${0##*/} 87 | 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | MAX_FD=$( ulimit -H -n ) || 147 | warn "Could not query maximum file descriptor limit" 148 | esac 149 | case $MAX_FD in #( 150 | '' | soft) :;; #( 151 | *) 152 | ulimit -n "$MAX_FD" || 153 | warn "Could not set maximum file descriptor limit to $MAX_FD" 154 | esac 155 | fi 156 | 157 | # Collect all arguments for the java command, stacking in reverse order: 158 | # * args from the command line 159 | # * the main class name 160 | # * -classpath 161 | # * -D...appname settings 162 | # * --module-path (only if needed) 163 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 164 | 165 | # For Cygwin or MSYS, switch paths to Windows format before running java 166 | if "$cygwin" || "$msys" ; then 167 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 168 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 169 | 170 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 171 | 172 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 173 | for arg do 174 | if 175 | case $arg in #( 176 | -*) false ;; # don't mess with options #( 177 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 178 | [ -e "$t" ] ;; #( 179 | *) false ;; 180 | esac 181 | then 182 | arg=$( cygpath --path --ignore --mixed "$arg" ) 183 | fi 184 | # Roll the args list around exactly as many times as the number of 185 | # args, so each arg winds up back in the position where it started, but 186 | # possibly modified. 187 | # 188 | # NB: a `for` loop captures its iteration list before it begins, so 189 | # changing the positional parameters here affects neither the number of 190 | # iterations, nor the values presented in `arg`. 191 | shift # remove old arg 192 | set -- "$@" "$arg" # push replacement arg 193 | done 194 | fi 195 | 196 | # Collect all arguments for the java command; 197 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 198 | # shell script including quotes and variable substitutions, so put them in 199 | # double quotes to make sure that they get re-expanded; and 200 | # * put everything else in single quotes, so that it's not re-expanded. 201 | 202 | set -- \ 203 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 204 | -classpath "$CLASSPATH" \ 205 | org.gradle.wrapper.GradleWrapperMain \ 206 | "$@" 207 | 208 | # Use "xargs" to parse quoted args. 209 | # 210 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 211 | # 212 | # In Bash we could simply go: 213 | # 214 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 215 | # set -- "${ARGS[@]}" "$@" 216 | # 217 | # but POSIX shell has neither arrays nor command substitution, so instead we 218 | # post-process each arg (as a line of input to sed) to backslash-escape any 219 | # character that might be a shell metacharacter, then use eval to reverse 220 | # that process (while maintaining the separation between arguments), and wrap 221 | # the whole thing up as a single "set" statement. 222 | # 223 | # This will of course break if any of these variables contains a newline or 224 | # an unmatched quote. 225 | # 226 | 227 | eval "set -- $( 228 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 229 | xargs -n1 | 230 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 231 | tr '\n' ' ' 232 | )" '"$@"' 233 | 234 | exec "$JAVACMD" "$@" 235 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /src/main/java/io/otel/pyroscope/OtelCompat.java: -------------------------------------------------------------------------------- 1 | package io.otel.pyroscope; 2 | 3 | import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties; 4 | 5 | public class OtelCompat { 6 | // For compat reasons 7 | // io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties.getBoolean(java.lang.String, boolean) is only since 1.15 8 | static boolean getBoolean(ConfigProperties cfg, String name, boolean defaultValue) { 9 | Boolean v = cfg.getBoolean(name); 10 | if (v == null) { 11 | return defaultValue; 12 | } 13 | return v; 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /src/main/java/io/otel/pyroscope/OtelProfilerSdkBridge.java: -------------------------------------------------------------------------------- 1 | package io.otel.pyroscope; 2 | 3 | import io.pyroscope.javaagent.api.ProfilerApi; 4 | import io.pyroscope.javaagent.api.ProfilerScopedContext; 5 | 6 | import java.lang.reflect.Method; 7 | import java.util.Map; 8 | import java.util.function.BiConsumer; 9 | 10 | public class OtelProfilerSdkBridge implements ProfilerApi { 11 | 12 | private final Object sdkInstance; 13 | private final Method registerConstant; 14 | 15 | 16 | public OtelProfilerSdkBridge(Object sdkInstance, Method registerConstant) { 17 | this.sdkInstance = sdkInstance; 18 | this.registerConstant = registerConstant; 19 | } 20 | 21 | @Override 22 | public void startProfiling() { 23 | try { 24 | Method method = sdkInstance.getClass().getDeclaredMethod("startProfiling"); 25 | method.invoke(sdkInstance); 26 | } catch (Exception e) { 27 | throw new RuntimeException(e); 28 | } 29 | } 30 | 31 | @Override 32 | public boolean isProfilingStarted() { 33 | try { 34 | Method method = sdkInstance.getClass().getDeclaredMethod("isProfilingStarted"); 35 | return (boolean) method.invoke(sdkInstance); 36 | } catch (Exception e) { 37 | throw new RuntimeException(e); 38 | } 39 | } 40 | 41 | @Override 42 | public ProfilerScopedContext createScopedContext(Map labels) { 43 | try { 44 | Method method = sdkInstance.getClass().getDeclaredMethod("createScopedContext", Map.class); 45 | Object ctx = method.invoke(sdkInstance, labels); 46 | 47 | return new ProfilerScopedContext() { 48 | 49 | @Override 50 | public void forEachLabel(BiConsumer biConsumer) { 51 | try { 52 | Method forEachLabelMethod = ctx.getClass().getDeclaredMethod("forEachLabel", BiConsumer.class); 53 | forEachLabelMethod.invoke(ctx, biConsumer); 54 | } catch (Exception e) { 55 | throw new RuntimeException(e); 56 | } 57 | } 58 | 59 | @Override 60 | public void close() { 61 | try { 62 | Method closeMethod = ctx.getClass().getDeclaredMethod("close"); 63 | closeMethod.invoke(ctx); 64 | } catch (Exception e) { 65 | throw new RuntimeException(e); 66 | } 67 | } 68 | }; 69 | 70 | } catch (Exception e) { 71 | throw new RuntimeException(e); 72 | } 73 | } 74 | 75 | @Override 76 | public void setTracingContext(long profileId, long spanName) { 77 | try { 78 | Method method = sdkInstance.getClass().getDeclaredMethod("setTracingContext", long.class, long.class); 79 | method.invoke(sdkInstance, profileId, spanName); 80 | } catch (Exception e) { 81 | throw new RuntimeException(e); 82 | } 83 | } 84 | 85 | @Override 86 | public long registerConstant(String s) { 87 | try { 88 | return (Long) registerConstant.invoke(null, s); 89 | } catch (Exception e) { 90 | return 0; 91 | } 92 | } 93 | } 94 | -------------------------------------------------------------------------------- /src/main/java/io/otel/pyroscope/PyroscopeOtelAutoConfigurationCustomizerProvider.java: -------------------------------------------------------------------------------- 1 | package io.otel.pyroscope; 2 | 3 | 4 | import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer; 5 | import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider; 6 | import io.pyroscope.javaagent.PyroscopeAgent; 7 | import io.pyroscope.javaagent.config.Config; 8 | 9 | import java.lang.reflect.Method; 10 | import java.util.Base64; 11 | 12 | import static io.otel.pyroscope.OtelCompat.getBoolean; 13 | 14 | 15 | public class PyroscopeOtelAutoConfigurationCustomizerProvider 16 | implements AutoConfigurationCustomizerProvider { 17 | 18 | 19 | @Override 20 | public void customize(AutoConfigurationCustomizer autoConfiguration) { 21 | autoConfiguration.addTracerProviderCustomizer((tpBuilder, cfg) -> { 22 | OtelProfilerSdkBridge profilerSdk = null; 23 | try { 24 | profilerSdk = loadProfilerSdk(); 25 | } catch (Exception e) { 26 | // This usually means we are running without the Pyroscope SDK. 27 | // We'll instead use the Profiler bundled with the extension. 28 | // todo do not print or at least silence this by default 29 | System.out.println("Could not load the profiler SDK, will continue with the built-in one!"); 30 | //e.printStackTrace(); 31 | } 32 | 33 | boolean startProfiling = getBoolean(cfg, "otel.pyroscope.start.profiling", true); 34 | if (startProfiling) { 35 | if (profilerSdk == null) { 36 | PyroscopeAgent.start(Config.build()); 37 | } else if (!profilerSdk.isProfilingStarted()) { 38 | profilerSdk.startProfiling(); 39 | } 40 | } 41 | 42 | PyroscopeOtelConfiguration pyroOtelConfig = new PyroscopeOtelConfiguration.Builder() 43 | .setRootSpanOnly(getBoolean(cfg, "otel.pyroscope.root.span.only", true)) 44 | .setAddSpanName(getBoolean(cfg, "otel.pyroscope.add.span.name", true)) 45 | .build(); 46 | 47 | return tpBuilder.addSpanProcessor( 48 | new PyroscopeOtelSpanProcessor( 49 | pyroOtelConfig, 50 | profilerSdk 51 | )); 52 | }); 53 | } 54 | 55 | /** 56 | * Open Telemetry extension classes are loaded by an isolated class loader. 57 | * As such, they can't communicate with other parts of the application (e.g., the Pyroscope SDK). 58 | *

59 | * If the Pyroscope SDK is loaded as a java agent, we'll access it via the system class loader and interact with it 60 | * via a bridge. 61 | */ 62 | private static OtelProfilerSdkBridge loadProfilerSdk() { 63 | try { 64 | ClassLoader systemClassLoader = ClassLoader.getSystemClassLoader(); 65 | Class sdkClass = systemClassLoader.loadClass("io.pyroscope.javaagent.ProfilerSdk"); 66 | Object sdk = sdkClass.getDeclaredConstructor().newInstance(); 67 | 68 | Class labelsWrapperClass = systemClassLoader.loadClass(getLabelsWrapperClassName()); 69 | Method registerConstant = labelsWrapperClass.getDeclaredMethod("registerConstant", String.class); 70 | 71 | return new OtelProfilerSdkBridge(sdk, registerConstant); 72 | } catch (Exception e) { 73 | throw new RuntimeException("Error loading the profiler SDK", e); 74 | } 75 | } 76 | 77 | private static String getLabelsWrapperClassName() { 78 | // otherwise the relocate plugin renames this string :shrug: 79 | return new String(Base64.getDecoder().decode("aW8ucHlyb3Njb3BlLmxhYmVscy52Mi5QeXJvc2NvcGUkTGFiZWxzV3JhcHBlcg==")); 80 | } 81 | } -------------------------------------------------------------------------------- /src/main/java/io/otel/pyroscope/PyroscopeOtelConfiguration.java: -------------------------------------------------------------------------------- 1 | package io.otel.pyroscope; 2 | 3 | 4 | public class PyroscopeOtelConfiguration { 5 | //todo think about removing both options, so that users don't need to configure or think about anything 6 | final boolean rootSpanOnly; 7 | final boolean addSpanName; 8 | 9 | private PyroscopeOtelConfiguration(Builder builder) { 10 | this.rootSpanOnly = builder.rootSpanOnly; 11 | this.addSpanName = builder.addSpanName; 12 | } 13 | 14 | @Override 15 | public String toString() { 16 | return "PyroscopeOtelConfiguration{" + 17 | ", rootSpanOnly=" + rootSpanOnly + 18 | ", addSpanName=" + addSpanName + 19 | '}'; 20 | } 21 | 22 | public static class Builder { 23 | boolean rootSpanOnly = true; 24 | boolean addSpanName = true; 25 | 26 | public Builder() { 27 | } 28 | 29 | public Builder setRootSpanOnly(boolean rootSpanOnly) { 30 | this.rootSpanOnly = rootSpanOnly; 31 | return this; 32 | } 33 | 34 | public Builder setAddSpanName(boolean addSpanName) { 35 | this.addSpanName = addSpanName; 36 | return this; 37 | } 38 | 39 | public PyroscopeOtelConfiguration build() { 40 | return new PyroscopeOtelConfiguration(this); 41 | } 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /src/main/java/io/otel/pyroscope/PyroscopeOtelSpanProcessor.java: -------------------------------------------------------------------------------- 1 | package io.otel.pyroscope; 2 | 3 | import io.opentelemetry.api.common.AttributeKey; 4 | import io.opentelemetry.api.trace.SpanContext; 5 | import io.opentelemetry.context.Context; 6 | import io.opentelemetry.sdk.trace.ReadWriteSpan; 7 | import io.opentelemetry.sdk.trace.ReadableSpan; 8 | import io.opentelemetry.sdk.trace.SpanProcessor; 9 | 10 | import io.pyroscope.PyroscopeAsyncProfiler; 11 | import io.pyroscope.labels.v2.Pyroscope; 12 | import io.pyroscope.vendor.one.profiler.AsyncProfiler; 13 | 14 | 15 | public final class PyroscopeOtelSpanProcessor implements SpanProcessor { 16 | 17 | private static final AttributeKey ATTRIBUTE_KEY_PROFILE_ID = AttributeKey.stringKey("pyroscope.profile.id"); 18 | 19 | private final PyroscopeOtelConfiguration configuration; 20 | private final OtelProfilerSdkBridge profilerSdk; 21 | private final AsyncProfiler asprof; 22 | 23 | public PyroscopeOtelSpanProcessor(PyroscopeOtelConfiguration configuration, OtelProfilerSdkBridge profilerSdk) { 24 | this.configuration = configuration; 25 | this.profilerSdk = profilerSdk; 26 | if (profilerSdk == null) { 27 | asprof = PyroscopeAsyncProfiler.getAsyncProfiler(); 28 | } else { 29 | asprof = null; 30 | } 31 | } 32 | 33 | @Override 34 | public boolean isStartRequired() { 35 | return true; 36 | } 37 | 38 | @Override 39 | public boolean isEndRequired() { 40 | return true; 41 | } 42 | 43 | @Override 44 | public void onStart(Context parentContext, ReadWriteSpan span) { 45 | if (configuration.rootSpanOnly && !isRootSpan(span)) { 46 | return; 47 | } 48 | String strProfileId = span.getSpanContext().getSpanId(); 49 | long spanName; 50 | long spanId = parseSpanId(strProfileId); 51 | if (configuration.addSpanName) { 52 | spanName = registerConstant(span.getName()); 53 | } else { 54 | spanName = 0; 55 | } 56 | 57 | span.setAttribute(ATTRIBUTE_KEY_PROFILE_ID, strProfileId); 58 | setTracingContextForSpan(spanId, spanName); 59 | } 60 | 61 | 62 | @Override 63 | public void onEnd(ReadableSpan span) { 64 | setTracingContextForSpan(0, 0); 65 | } 66 | 67 | private void setTracingContextForSpan(long spanId, long spanName) { 68 | if (profilerSdk != null) { 69 | profilerSdk.setTracingContext(spanId, spanName); 70 | } 71 | if (asprof != null) { 72 | asprof.setTracingContext(spanId, spanName); 73 | } 74 | } 75 | 76 | private long registerConstant(String name) { 77 | if (profilerSdk != null) { 78 | return profilerSdk.registerConstant(name); 79 | } 80 | return Pyroscope.LabelsWrapper.registerConstant(name); 81 | } 82 | 83 | 84 | public static long parseSpanId(String strProfileId) { 85 | if (strProfileId == null || strProfileId.length() != 16) { 86 | return 0L; 87 | } 88 | try { 89 | return Long.parseUnsignedLong(strProfileId, 16); 90 | } catch (NumberFormatException e) { 91 | return 0; 92 | } 93 | } 94 | 95 | public static boolean isRootSpan(ReadableSpan span) { 96 | SpanContext parent = span.getParentSpanContext(); 97 | boolean noParent = parent == SpanContext.getInvalid(); 98 | boolean remote = parent.isRemote(); 99 | return remote || noParent; 100 | } 101 | } 102 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/services/io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider: -------------------------------------------------------------------------------- 1 | io.otel.pyroscope.PyroscopeOtelAutoConfigurationCustomizerProvider -------------------------------------------------------------------------------- /src/test/java/io/otel/pyroscope/PyroscopeOtelSpanProcessorTest.java: -------------------------------------------------------------------------------- 1 | package io.otel.pyroscope; 2 | 3 | import org.junit.jupiter.api.Assertions; 4 | import org.junit.jupiter.api.Test; 5 | 6 | public class PyroscopeOtelSpanProcessorTest { 7 | 8 | @Test 9 | void testParseSpanId() { 10 | Assertions.assertEquals(0, PyroscopeOtelSpanProcessor.parseSpanId("0")); 11 | Assertions.assertEquals(0, PyroscopeOtelSpanProcessor.parseSpanId(null)); 12 | Assertions.assertEquals(0, PyroscopeOtelSpanProcessor.parseSpanId("gggggggggggggggg")); 13 | Assertions.assertEquals(0xcafe, PyroscopeOtelSpanProcessor.parseSpanId("000000000000cafe")); 14 | Assertions.assertEquals(-4748286662364504709L, PyroscopeOtelSpanProcessor.parseSpanId("be1ab2702609dd7b")); 15 | } 16 | } 17 | --------------------------------------------------------------------------------