Add markdown link checking to build

.github/config/markdown-link-check-config.json

@@ -0,0 +1,11 @@
+{
+  "retryOn429": true,
+  "aliveStatusCodes": [
+    200,
+    403
+  ],
+  "ignorePatterns": [
+    { "pattern": "https:\\/\\/.*.nr-data\\.net.*" },
+    { "pattern": "http:\\/\\/localhost:[0-9]*" }
+  ]
+}

.github/scripts/markdown-link-check-with-retry.sh

@@ -0,0 +1,17 @@
+#!/bin/bash -e
+
+# this script helps to reduce sporadic link check failures by retrying at a file-by-file level
+
+retry_count=3
+
+for file in "$@"; do
+  for i in $(seq 1 $retry_count); do
+    if markdown-link-check --config "$(dirname "$0")/../config/markdown-link-check-config.json" \
+                           "$file"; then
+      break
+    elif [[ $i -eq $retry_count ]]; then
+      exit 1
+    fi
+    sleep 5
+  done
+done

.github/workflows/pull_request.yml

@@ -20,3 +20,18 @@ jobs:
       - name: Build getting-started-guides/java with Gradle
         working-directory: getting-started-guides/java
         run: ./gradlew build
+
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install markdown-link-check
+        # TODO(jack-berg): use latest when config file reading bug is fixed: https://github.com/tcort/markdown-link-check/issues/246
+        run: npm install -g [email protected]
+
+      - name: Run markdown-link-check
+        run: |
+          find . -type f \
+                 -name '*.md' \
+               | xargs .github/scripts/markdown-link-check-with-retry.sh

.gitignore

@@ -13,3 +13,6 @@ build/
 # Python
 venv
 __pycache__
+
+# Docker
+.env

CONTRIBUTING.md

@@ -1,16 +1,16 @@
 # Contributing
 
 Contributions are always welcome. Before contributing please read the
-[code of conduct](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md) and [search the issue tracker](../../issues); your issue may have already been discussed or fixed in `main`. To contribute,
+[code of conduct](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md) and [search the issue tracker](https://github.com/newrelic/newrelic-opentelemetry-examples/issues); your issue may have already been discussed or fixed in `main`. To contribute,
 [fork](https://help.github.com/articles/fork-a-repo/) this repository, commit your changes, and [send a Pull Request](https://help.github.com/articles/using-pull-requests/).
 
 Note that our [code of conduct](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md) applies to all platforms and venues related to this project; please follow it in all your interactions with the project and its participants.
 
 ## Feature Requests
 
-Feature requests should be submitted in the [Issue tracker](../../issues), with a description of the expected behavior & use case, where they’ll remain closed until sufficient interest, [e.g. :+1: reactions](https://help.github.com/articles/about-discussions-in-issues-and-pull-requests/), has been [shown by the community](../../issues?q=label%3A%22votes+needed%22+sort%3Areactions-%2B1-desc).
+Feature requests should be submitted in the [Issue tracker](https://github.com/newrelic/newrelic-opentelemetry-examples/issues), with a description of the expected behavior & use case, where they’ll remain closed until sufficient interest, [e.g. :+1: reactions](https://help.github.com/articles/about-discussions-in-issues-and-pull-requests/), has been [shown by the community](https://github.com/newrelic/newrelic-opentelemetry-examples/issues?q=label%3A%22votes+needed%22+sort%3Areactions-%2B1-desc).
 Before submitting an Issue, please search for similar ones in the
-[closed issues](../../issues?q=is%3Aissue+is%3Aclosed+label%3Aenhancement).
+[closed issues](https://github.com/newrelic/newrelic-opentelemetry-examples/issues?q=is%3Aissue+is%3Aclosed+label%3Aenhancement).
 
 ## Pull Requests
 

README.md

@@ -40,28 +40,28 @@ See [Contribute](#contribute) for how to request OpenTelemetry/New Relic interac
 
 ## Examples Index
 
-- Collector
-  - [OpenTelemetry Collector with OTLP Export to New Relic](./collector): Run the OpenTelemetry Collector with OTLP gRPC export to New Relic.
-- Java
-  - [OpenTelemetry Agent New Relic Config](./java/agent-nr-config): A Java application with the OpenTelemetry Agent configured for New Relic.
-  - [Micrometer Shim with OTLP Export](./java/logs-in-context-log4j2): A Spring Boot Java application with micrometer installed, configured to use the OpenTelemetry micrometer shim and export to New Relic using OTLP.
-  - [Logs In Context With Log4j2](./java/logs-in-context-log4j2): A Java application configured to include OpenTelemetry trace context on Log4j2 structured logs.
-  - [OpenTelemetry SDK New Relic Config](./java/sdk-nr-config): A Java application with OpenTelemetry standalone library instrumentation as well as custom instrumentation, configured for New Relic via the SDK.
-  - [OTLP New Relic Mapping](./java/otlp-nr-mapping): Contains a variety of test cases demonstrating how OTLP payloads are mapped to records in NRDB upon ingest.
-- .NET
-  - [OpenTelemetry SDK New Relic Config](./dotnet/aspnetcore/) Simple ASP.NET Core application demonstrating OpenTelemetry instrumentation.
-- JavaScript
-  - [OpenTelemetry SDK New Relic Config](./javascript/simple-nodejs-app-http-exp): An express application demonstrating OpenTelemetry auto-instrumentation, configured for New Relic via the SDK.
-- Python
-  - [OpenTelemetry SDK New Relic Config](./python): Two simple Python application demonstrating OpenTelemetry instrumentation, one with Flask auto-instrumentation and one without Flask. Configured for New Relic via the SDK.
-- Go
-  - [OpenTelemetry SDK New Relic Config](./go): Simple Go applications demonstrating OpenTelemetry instrumentation.
-- Ruby
-  - [OpenTelemetry SDK New Relic Config](./ruby): A Sinatra application with automatic and manual instrumentation.
-- Serverless
-  - AWS Lambda
-    - [OpenTelemetry Lambda .NET New Relic Config](./serverless/aws-lambda/dotnet): An example AWS .NET Lambda function instrumented with OpenTelemetry.
-    - [OpenTelemetry Lambda Java New Relic Config](./serverless/aws-lambda/java): An example AWS Java Lambda function instrumented with OpenTelemetry.
+- [Getting Started Guides](./getting-started-guides/README.md)
+  - .NET ([uninstrumented](./getting-started-guides/dotnet/Uninstrumented) / [instrumented](./getting-started-guides/dotnet/Instrumented))
+  - Go ([uninstrumented](./getting-started-guides/go/uninstrumented) / [instrumented](./getting-started-guides/go/instrumented))
+  - Java ([uninstrumented](./getting-started-guides/java/uninstrumented) / [instrumented](./getting-started-guides/java/instrumented))
+  - Javascript ([uninstrumented](./getting-started-guides/javascript/uninstrumented) / [instrumented](./getting-started-guides/javascript/instrumented))
+  - Python ([uninstrumented](./getting-started-guides/python/Uninstrumented) / [instrumented](./getting-started-guides/python/Instrumented))
+  - Ruby ([uninstrumented](./getting-started-guides/ruby/uninstrumented) / [instrumented](./getting-started-guides/ruby/instrumented))
+- Other Examples
+  - Collector
+    - [OpenTelemetry Collector with OTLP Export to New Relic](./other-examples/collector): Run the OpenTelemetry Collector with OTLP gRPC export to New Relic.
+  - Java
+    - [OpenTelemetry Agent New Relic Config](./other-examples/java/agent-nr-config): A Java application with the OpenTelemetry Agent configured for New Relic.
+    - [Micrometer Shim with OTLP Export](./other-examples/java/micrometer-shim): A Spring Boot Java application with micrometer installed, configured to use the OpenTelemetry micrometer shim and export to New Relic using OTLP.
+    - [Logs In Context With Log4j2](./other-examples/java/logs-in-context-log4j2): A Java application configured to include OpenTelemetry trace context on Log4j2 structured logs.
+  - .NET
+    - [OpenTelemetry Agent With New Relic Config](./other-examples/dotnet/agent-nr-config) A simple .NET application running with the OpenTelemetry Automatic Instrumentation Agent.
+  - Serverless
+    - AWS Lambda
+      - [OpenTelemetry Lambda .NET New Relic Config](./other-examples/serverless/aws-lambda/dotnet): An example AWS .NET Lambda function instrumented with OpenTelemetry.
+      - [OpenTelemetry Lambda Java New Relic Config](./other-examples/serverless/aws-lambda/java): An example AWS Java Lambda function instrumented with OpenTelemetry.
+    - Azure Functions
+      - [OpenTelemetry Azure Functions Node New Relic Config](./other-examples/serverless/azure-functions/node/http-trigger-app): An example Azure Function App that includes an HTTP trigger Azure Function instrumented using Open Telemetry.
 
 ## Contribute
 
@@ -73,7 +73,7 @@ If you have any questions, or to execute our corporate CLA (which is required if
 
 **A note about vulnerabilities**
 
-As 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.
+As noted in our [security policy](https://github.com/newrelic/newrelic-opentelemetry-examples/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](https://hackerone.com/newrelic).
 

getting-started-guides/javascript/instrumented/README.md

@@ -60,7 +60,7 @@ npm install
 ```bash
 npm start
 ```
-The above command will use [parcel]([https://](https://parceljs.org/)) to build the frontend and start the server. 
+The above command will use [parcel](https://parceljs.org/) to build the frontend and start the server. 
 
 2. Open your browser and navigate to [http://localhost:8080](http://localhost:8080) to access the app.
 
@@ -98,7 +98,7 @@ npm install @opentelemetry/api \
   @opentelemetry/resources \
   @opentelemetry/semantic-conventions
 ```
-Refer to the [manual-otel-web.js](./src/public/custom-otel-web.js) file for the implementation details.
+Refer to the [manual-otel-web.js](./src/public/manual-otel-web.js) file for the implementation details.
 
 ## Open Telemetry Auto Instrumentation for Backend (Node.js)
 

getting-started-guides/javascript/uninstrumented/README.md

@@ -60,7 +60,7 @@ npm install
 ```bash
 npm start
 ```
-The above command will use [parcel]([https://](https://parceljs.org/)) to build the frontend and start the server. 
+The above command will use [parcel](https://parceljs.org/) to build the frontend and start the server. 
 
 2. Open your browser and navigate to [http://localhost:8080](http://localhost:8080) to access the app.
 

other-examples/java/logs-in-context-log4j2/README.md

@@ -4,7 +4,7 @@
 
 This project contains a Java application configured to use [Log4j2](https://logging.apache.org/log4j/2.x/) to write JSON structured logs that propagate OpenTelemetry trace context onto log messages. It also contains a [docker-compose.yaml](./docker-compose.yaml) which illustrates how to forward these logs to an OpenTelemetry Collector, and onto New Relic.
 
-The [log4j2.xml](./src/main/resources/log4j2.xml) configures the application to log out to the console with a [JSON Template Layout](https://logging.apache.org/log4j/2.x/manual/json-template-layout.html) defined in [Log4j2EventLayout.json](./src/main/resources/Log4j2EventLayout.json).
+The [log4j2.xml](./log4j2.xml) configures the application to log out to the console with a [JSON Template Layout](https://logging.apache.org/log4j/2.x/manual/json-template-layout.html) defined in [Log4j2EventLayout.json](./Log4j2EventLayout.json).
 
 The application uses the [OpenTelemetry Log4j2 Integration](https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/log4j/log4j-context-data/log4j-context-data-2.17/library-autoconfigure) to inject trace context to Log4j2 [thread context](https://logging.apache.org/log4j/2.x/manual/thread-context.html).
 
@@ -23,7 +23,7 @@ The result is JSON structured logs, with one JSON object per line, which have th
 }
 ```
 
-The OpenTelemetry Log specification defines that when propagating [trace context in legacy formats](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/compatibility/logging_trace_context.md), `trace_id` and `span_id` should be used. However, [New Relic structured logging conventions](https://github.com/newrelic/newrelic-exporter-specs/tree/master/logging) expect trace context to be propagated as `trace.id` and `span.id`. The [transform](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/transformprocessor) processor is defined in the collector config to replace `trace_id` => `trace.id`, and `span_id` => `span.id`. Alternatively, this mapping could be done in the [Log4j2 JSON layout](./src/main/resources/Log4j2EventLayout.json), which may be more performant.
+The OpenTelemetry Log specification defines that when propagating [trace context in legacy formats](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/compatibility/logging_trace_context.md), `trace_id` and `span_id` should be used. However, [New Relic structured logging conventions](https://github.com/newrelic/newrelic-exporter-specs/tree/master/logging) expect trace context to be propagated as `trace.id` and `span.id`. The [transform](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/transformprocessor) processor is defined in the collector config to replace `trace_id` => `trace.id`, and `span_id` => `span.id`. Alternatively, this mapping could be done in the [Log4j2 JSON layout](./Log4j2EventLayout.json), which may be more performant.
 
 ## Run
 

other-examples/serverless/aws-lambda/dotnet/README.md

@@ -8,7 +8,7 @@ This example assumes you have the following:
 
 * A New Relic account. If you don't have one, [create one for free](https://newrelic.com/signup).
 * An AWS account. If you don't have one, [create one for free](https://aws.amazon.com/).
-* A [New Relic license key](/docs/apis/intro-apis/new-relic-api-keys/#ingest-keys) from your New Relic account.
+* A [New Relic license key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#ingest-keys) from your New Relic account.
 
 It also assumes you have the following installed:
 

other-examples/serverless/aws-lambda/java/README.md

@@ -8,7 +8,7 @@ This example assumes you have the following:
 
 * A New Relic account. If you don't have one, [create one for free](https://newrelic.com/signup).
 * An AWS account. If you don't have one, [create one for free](https://aws.amazon.com/).
-* A [New Relic license key](/docs/apis/intro-apis/new-relic-api-keys/#ingest-keys) from your New Relic account.
+* A [New Relic license key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#ingest-keys) from your New Relic account.
 
 It also assumes you have the following installed:
 

other-examples/serverless/azure-functions/node/http-trigger-app/readme.md

@@ -14,11 +14,11 @@ This example currently only exports trace data and does not have metric examples
 
 Traces are buffered using a `BatchSpanProcessor`. The batch span processor will export when either the timeout is hit, the buffer size limit is hit, or the function completes execution via a call to force flush.
 
-A minimal amount of useful HTTP specific data has been captured for this example. You may wish to capture additional details and add according to the [HTTP Semantic Conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md).
+A minimal amount of useful HTTP specific data has been captured for this example. You may wish to capture additional details and add according to the [HTTP Semantic Conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md).
 
 See also the FAAS Semantic conventions, which are currently experimental and subject to change:
-* https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/faas.md
-* https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/faas.md
+* https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/faas.md
+* https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/faas-spans.md
 
 ## Required/Recommended Configuration