This repository is archived and deprecated in favor of https://github.com/newrelic-experimental/nr-apigee-integration.
This repository includes Apigee Javascript Resources for
- Creating or propagating W3C Trace Context through Apigee Flows and on to the Apigee Target
- Reporting Flow Request/Response pairs as Spans to New Relic's Trace API
The repository also includes sample policies to demonstrate how the pieces work together.
The documentation requires fluency with Apigee.
- Copy the Javascript Resources into the
resources/jscfolder of the Proxy - Copy newrelic-sample.properties file to
resources/properties/newrelic.propertiesin the Proxy - Create a Request/Response Policy pair for each Flow step measured. At a minimum one pair is required to ensure that a Trace Context is present for a Target.
All Resource and Policy files include complete in-file documentation, see them for details
Nothing required
- Edit the
newrelic.propertiesfile and add your New Relic License Key.
- Proxy policies must be paired, one in a Request Flow and one in a Response Flow
- Flow execution sequence
- Start/End timestamps: Apigee Flow Variables
- W3C Trace Context
- Apigee development with VSCode
- Apigee JavaScript object model
- Rhino features by release (Apigee uses Rhino 1.7..7.1, it's fairly limited.)
- New Relic Trace API Payload
New 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.
We encourage you to bring your experiences and questions to the Explorers Hub where our community members collaborate on solutions and new ideas.
We encourage your contributions to improve Apigee Distributed Tracing! 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.
As noted in our 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.
If 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.
Apigee Distributed Tracing is licensed under the Apache 2.0 License.