Initial release

Author: msummers-nr

README.md

@@ -21,11 +21,11 @@ The repository also includes [sample policies](src/main/apigee/apiproxies/W3C-Tr
 **The documentation requires fluency with Apigee.**
 
 ## Installation
-1. Copy the JavaScript resources into the `resources/jsc` folder
-2. Copy `newrelic-sample.properties` file to `resources/properties/newrelic.properties`
+1. Copy the [Javascript Resources](src/main/apigee/apiproxies/W3C-Trace-Context/apiproxy/resources/jsc) into the `resources/jsc` folder of the Proxy
+2. Copy [newrelic-sample.properties](src/main/apigee/apiproxies/W3C-Trace-Context/apiproxy/resources/properties/newrelic-sample.properties) file to `resources/properties/newrelic.properties` in the Proxy
 3. 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.
-  - [Sample Request Policy](src/main/apigee/apiproxies/W3C-Trace-Context/apiproxy/policies/Trace-Context-Request.xml)
-  - [Sample Response Policy](src/main/apigee/apiproxies/W3C-Trace-Context/apiproxy/policies/Trace-Context-Response.xml)
+   - [Sample Request Policy](src/main/apigee/apiproxies/W3C-Trace-Context/apiproxy/policies/Trace-Context-Request.xml)
+   - [Sample Response Policy](src/main/apigee/apiproxies/W3C-Trace-Context/apiproxy/policies/Trace-Context-Response.xml)
 
 ## Configuration
 All Resource and Policy files include complete in-file documentation, see them for details

src/main/apigee/apiproxies/W3C-Trace-Context/apiproxy/policies/Target-Trace-Context-Request.xml

@@ -19,7 +19,8 @@
 
         <!-- OPTIONAL
          A comma separated list of key=value pairs propagated  in the tracestate header.
-        https://www.w3.org/TR/trace-context/#tracestate-header -->
+        https://www.w3.org/TR/trace-context/#tracestate-header
+        Default: no default value -->
         <Property name="AdditionalTracestateValues"></Property>
 
     </Properties>

src/main/apigee/apiproxies/W3C-Trace-Context/apiproxy/resources/jsc/Trace-Context-Request.js

@@ -1,10 +1,37 @@
 'use strict';
 
-// TODO validate Policy properties
+var logPrefix = 'TraceContextRequest: ';
+// <!-- OPTIONAL
+// The odds of a Trace being sampled, 0-100. 0 = tracing off, 100 = trace everything.
+// Default: 100 -->
+// <Property name="SampleOddsPercentage">100</Property>
+var SampleOddsPercentage = contextGetVariable(properties.SampleOddsPercentage, 100);
+// <!-- REQUIRED
+// The name of the Request/Response pair. Must be unique within a Proxy.
+// Default: no default value -->
+// <Property name="RequestResponsePairName">Target-Trace-Context-Flow</Property>
 
-var startTime = contextGetVariable(properties.TraceStartTimestamp, Date.now());
 var RequestResponsePairName = properties.RequestResponsePairName;
-var logPrefix = RequestResponsePairName + '.TraceContextRequest: ';
+if(isNil(RequestResponsePairName)){
+    print(logPrefix + "ERROR: invalid RequestResponsePairName: " + RequestResponsePairName);
+    logMsg(logPrefix + "ERROR: invalid RequestResponsePairName: " + RequestResponsePairName);
+    throw (logPrefix + "ERROR: invalid RequestResponsePairName: " + RequestResponsePairName);
+}
+logPrefix = RequestResponsePairName + '.TraceContextRequest: ';
+
+// <!-- OPTIONAL
+// How to determine the start time for this Trace. Any Flow Variable (https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference) ending in '.timestamp' is valid.
+// Default:`Date.now()'-->
+// <Property name="TraceStartTimestamp"></Property>
+var startTime = contextGetVariable(properties.TraceStartTimestamp, Date.now());
+
+// <!-- OPTIONAL
+//  A comma separated list of key=value pairs propagated  in the tracestate header.
+// https://www.w3.org/TR/trace-context/#tracestate-header
+// Default: no default value -->
+// <Property name="AdditionalTracestateValues"></Property>
+var additionalStates = properties.AdditionalTracestateValues;
+
 logMsg(logPrefix + 'enter');
 var ctxPrefix = 'traceContext.' + RequestResponsePairName;
 
@@ -63,15 +90,14 @@ function generateSampled() {
     // Give us a number 0 - 99 inclusive
     var n = Math.floor(Math.random() * 100);
     n = n + 1;
-    if (n <= properties.SampleOddsPercentage) {
+    if (n <= SampleOddsPercentage) {
         return '01';
     }
     return '00';
 }
 
 var traceparent = context.getVariable('request.header.traceparent');
 var tracestate = context.getVariable('request.header.tracestate.values.string');
-var additionalStates = properties.AdditionalTracestateValues;
 logMsg(logPrefix + 'traceparent: ' + traceparent + ' type: ' + typeof (traceparent));
 logMsg(logPrefix + 'tracestate: ' + tracestate + ' type: ' + typeof (tracestate));
 logMsg(logPrefix + 'additionalStates: ' + additionalStates + ' type: ' + typeof (additionalStates));

src/main/apigee/apiproxies/W3C-Trace-Context/apiproxy/resources/jsc/Trace-Context-Response.js

@@ -1,9 +1,19 @@
 'use strict';
 
-// TODO validate Policy properties
-
+var logPrefix = 'TraceContextResponse: ';
+// <!-- REQUIRED
+// The name of the Request/Response pair. Must be unique within a Proxy.
+// Default: no default value
+// -->
+// <Property name="RequestResponsePairName">Target-Trace-Context-Flow</Property>
 var RequestResponsePairName = properties.RequestResponsePairName;
-var logPrefix = RequestResponsePairName + '.TraceContextResponse: ';
+if(isNil(RequestResponsePairName)){
+    print(logPrefix + "ERROR: invalid RequestResponsePairName: " + RequestResponsePairName);
+    logMsg(logPrefix + "ERROR: invalid RequestResponsePairName: " + RequestResponsePairName);
+    throw (logPrefix + "ERROR: invalid RequestResponsePairName: " + RequestResponsePairName);
+}
+logPrefix = RequestResponsePairName + '.TraceContextResponse: ';
+
 logMsg(logPrefix + 'enter');
 var ctxPrefix = 'traceContext.' + RequestResponsePairName;
 
@@ -72,7 +82,7 @@ if ((traceFlags & 0x01) == 1) {
     }]
 
     var endpoint = context.getVariable('propertyset.newrelic.ENDPOINT');
-    var licenseKey = context.getVariable('propertyset.newrelic.LICENSE_KEY');
+    var licenseKey = contextGetVariable('propertyset.newrelic.LICENSE_KEY', 'https://trace-api.newrelic.com/trace/v1');
     if (isNil(licenseKey)) {
         print('ERROR: ' + logPrefix + ' missing New Relic LICENSE_KEY: ' + licenseKey);
         logMsg(logPrefix + ' ERROR missing New Relic LICENSE_KEY: ' + licenseKey);

src/main/apigee/apiproxies/W3C-Trace-Context/apiproxy/resources/properties/newrelic-sample.properties

@@ -12,6 +12,7 @@ LICENSE_KEY=<YOUR_LICENSE_KEY_HERE>
 #
 # API reporting endpoint.
 # See here: https://docs.newrelic.com/docs/distributed-tracing/trace-api/trace-api-general-requirements-limits/#requirements for other choices
+# Default value: https://trace-api.newrelic.com/trace/v1 
 ENDPOINT=https://trace-api.newrelic.com/trace/v1
 
 # Enable DEBUG to get runtime 'print' statements