{"id":20194774,"url":"https://github.com/newrelic-experimental/newrelic-java-ktor","last_synced_at":"2026-01-07T15:15:44.373Z","repository":{"id":169174471,"uuid":"644577754","full_name":"newrelic-experimental/newrelic-java-ktor","owner":"newrelic-experimental","description":"New Relic Java Instrumentation for the Ktor server and client frameworks","archived":false,"fork":false,"pushed_at":"2024-12-20T15:35:36.000Z","size":553,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-03-03T07:45:45.963Z","etag":null,"topics":["instrumentation","java","ktor","ktor-client","ktor-framework","ktor-server","newrelic","nrlabs","nrlabs-data","nrlabs-java-verify","nrlabs-odp","observability-data","scala"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/newrelic-experimental.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-23T20:16:05.000Z","updated_at":"2025-02-06T12:12:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"d1bf3b5c-eb51-42df-a1eb-5c0f142d6b8b","html_url":"https://github.com/newrelic-experimental/newrelic-java-ktor","commit_stats":null,"previous_names":["newrelic-experimental/newrelic-java-ktor"],"tags_count":3,"template":false,"template_full_name":"newrelic-experimental/java-instrumentation-template","purl":"pkg:github/newrelic-experimental/newrelic-java-ktor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newrelic-experimental%2Fnewrelic-java-ktor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newrelic-experimental%2Fnewrelic-java-ktor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newrelic-experimental%2Fnewrelic-java-ktor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newrelic-experimental%2Fnewrelic-java-ktor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/newrelic-experimental","download_url":"https://codeload.github.com/newrelic-experimental/newrelic-java-ktor/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newrelic-experimental%2Fnewrelic-java-ktor/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262477442,"owners_count":23317491,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["instrumentation","java","ktor","ktor-client","ktor-framework","ktor-server","newrelic","nrlabs","nrlabs-data","nrlabs-java-verify","nrlabs-odp","observability-data","scala"],"created_at":"2024-11-14T04:14:02.227Z","updated_at":"2026-01-07T15:15:44.367Z","avatar_url":"https://github.com/newrelic-experimental.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://opensource.newrelic.com/oss-category/#new-relic-experimental\"\u003e\u003cpicture\u003e\u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/Experimental.png\"\u003e\u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Experimental.png\"\u003e\u003cimg alt=\"New Relic Open Source experimental project banner.\" src=\"https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Experimental.png\"\u003e\u003c/picture\u003e\u003c/a\u003e\n\n\n![GitHub forks](https://img.shields.io/github/forks/newrelic-experimental/newrelic-java-ktor?style=social)\n![GitHub stars](https://img.shields.io/github/stars/newrelic-experimental/newrelic-java-ktor?style=social)\n![GitHub watchers](https://img.shields.io/github/watchers/newrelic-experimental/newrelic-java-ktor?style=social)\n\n![GitHub all releases](https://img.shields.io/github/downloads/newrelic-experimental/newrelic-java-ktor/total)\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/newrelic-experimental/newrelic-java-ktor)\n![GitHub last commit](https://img.shields.io/github/last-commit/newrelic-experimental/newrelic-java-ktor)\n![GitHub Release Date](https://img.shields.io/github/release-date/newrelic-experimental/newrelic-java-ktor)\n\n\n![GitHub issues](https://img.shields.io/github/issues/newrelic-experimental/newrelic-java-ktor)\n![GitHub issues closed](https://img.shields.io/github/issues-closed/newrelic-experimental/newrelic-java-ktor)\n![GitHub pull requests](https://img.shields.io/github/issues-pr/newrelic-experimental/newrelic-java-ktor)\n![GitHub pull requests closed](https://img.shields.io/github/issues-pr-closed/newrelic-experimental/newrelic-java-ktor)\n\n\n# New Relic Java Instrumentation for Ktor\n\nProvides instrumentation of both the client and server sides of Ktor.  This includes support for distributed tracing between the client and the server.\n\n## Installation\n\nIt is recommended to also use the instrumentation for Kotlin Coroutines: https://github.com/newrelic/newrelic-java-kotlin-coroutines  \nAdditionally it recommended to version 8.20.0 of the New Relic Java Agent in order to avoid problems with the retransformation of Kotlin classes.  This requires you to include a system property in the startup arguments of your application.  Include -Dnewrelic.config.class_transformer.clear_return_stacks=true   \nSee 8.20.0 Release Notes for more details (https://docs.newrelic.com/docs/release-notes/agent-release-notes/java-release-notes/java-agent-8200/)   \n   \nThis use this instrumentation.   \n1. Download the latest release.    \n2. In the New Relic Java Agent directory (directory containing newrelic.jar), create a directory named extensions if it doe not already exist.   \n3. Copy the jars into the extensions directory.  \n4. Add System Property described above to the startup arguments.\n5. Restart the application.   \n\n## Getting Started\n\nAfter deployment, you should get route names for your web transactions instead of the generic name provided by the agent.  \nYou should also see deeper visibiity into what is happening in your application via the enhanced transaction traces/distributed traces provided by this instrumentation.    \n   \n### Recommended Kotlin Coroutine Configuration   \nKtor intiates a long running lazy Coroutine that will dominate the transaction times for your application unless it is ignored.  Please use this version or later (https://github.com/newrelic/newrelic-java-kotlin-coroutines/releases/tag/v1.0.4) to enable this feature and  add io.ktor.server.netty.cio.RequestBodyHandler to the scopes elemeent in the Coroutines stanza in newrelic.yml as shown here: https://github.com/newrelic/newrelic-java-kotlin-coroutines?tab=readme-ov-file#configuring-scopes-to-ignore    \nThe Kotlin Coroutines instrumentation also will trace suspend functions so it recommended that you ignore internal Ktor suspend functions by adding the regular expression \".\\*io\\\\.ktor\\\\..\\*\" to the list of suspends to ignore.   \n   \n## Support\n\nNew Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. Issues and contributions should be reported to the project here on GitHub.\n\n\u003eWe encourage you to bring your experiences and questions to the [Explorers Hub](https://discuss.newrelic.com) where our community members collaborate on solutions and new ideas.\n\n## Contributing\n\nWe encourage your contributions to improve Salesforce Commerce Cloud for New Relic Browser! Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at opensource@newrelic.com.\n\n**A note about vulnerabilities**\n\nAs noted in our [security policy](../../security/policy), New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.\n\nIf you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through [HackerOne](https://hackerone.com/newrelic).\n\n## License\n\nNew Relic Java Instrumentation for Ktor is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.\n\n\u003e[If applicable: [Project Name] also uses source code from third-party libraries. You can find full details on which libraries are used and the terms under which they are licensed in the third-party notices document.]\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnewrelic-experimental%2Fnewrelic-java-ktor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnewrelic-experimental%2Fnewrelic-java-ktor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnewrelic-experimental%2Fnewrelic-java-ktor/lists"}