Merge pull request #2552 from newrelic/release

Merge release into main // 2024-09-11

.github/actions/build-validate-artifact/action.yml

@@ -0,0 +1,25 @@
+name: Build and Validate Artifact
+description: Reusable action to build and validate the component artifact
+inputs:
+  output-artifact:
+    description: 'If provided, the action will output the artifact to the build directory'
+    required: false
+
+runs:
+  using: composite
+  steps:
+    - name: Add data source ids to schema
+      shell: bash
+      run: |
+        cd utils && yarn add-datasource-ids
+
+    - name: Build & Validate Artifact
+      shell: bash
+      id: build-validate-artifact
+      run: |
+        cd utils && yarn build-validate-quickstart-artifact ${{ inputs.output-artifact && '--output-artifact' || '' }}
+
+    - name: Debugging output
+      shell: bash
+      if: ${{ runner.debug }}
+      run: ls -la utils/build

.github/actions/bump-version-tag/action.yml

@@ -0,0 +1,16 @@
+name: Bump version tag
+description: Bumps the version tag based on the latest version
+outputs:
+  tag:
+    description: The new tag prefixed with `v`
+    value: ${{ steps.versions.outputs.v-version }}
+runs:
+  using: composite
+  steps:
+    - name: Get next version
+      uses: reecetech/version-increment@a5d65984a6c6e8bbc30ece69d53d96e40736f24c
+      id: versions
+      with:
+        scheme: semver
+        increment: minor
+        use_api: true

.github/workflows/pr-checks.yml

@@ -0,0 +1,30 @@
+name: Validate PR Artifact
+
+on:
+  pull_request:
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
+        with:
+          ref: ${{ github.sha }}
+      - name: Setup workspace
+        uses: "./.github/actions/bootstrap"
+      - name: Validate PR Artifact
+        uses: "./.github/actions/build-validate-artifact"
+  validate-quickstart-ids:
+    runs-on: ubuntu-latest
+    if: ${{ github.base_ref == 'main' && github.head_ref == 'release' }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
+        with:
+          ref: ${{ github.sha }}
+      - name: Setup workspace
+        uses: "./.github/actions/bootstrap"
+      - name: Validate Quickstart IDs
+        run: |
+          cd utils && yarn validate-quickstart-ids

.github/workflows/release-artifact.yml

@@ -0,0 +1,50 @@
+#  This workflow runs when a tag is created with the `v` prefix or a push
+#  to main occurs. It runs our validation script, outputs the artifact,
+#  creates a new tag, Github release, and uploads/associates the artifact with the release.
+
+name: Release artifact
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
+
+# Permissions for attestation
+permissions:
+  id-token: write
+  contents: write
+  attestations: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
+        with:
+          ref: ${{ github.ref }}
+      - name: Setup workspace
+        uses: "./.github/actions/bootstrap"
+      - name: Validate and generate artifact
+        uses: "./.github/actions/build-validate-artifact"
+        with:
+          output-artifact: 'true'
+      - name: Attest artifact
+        uses: actions/attest-build-provenance@1c608d11d69870c2092266b3f9a6f3abbf17002c
+        with:
+          subject-path: utils/build/*
+      - name: Create new release tag
+        # Only run if this is a branch push (we'll need a new tag)
+        if: ${{ startsWith(github.ref, 'refs/heads') }}
+        id: version
+        uses: "./.github/actions/bump-version-tag"
+      - name: Create release
+        uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191
+        with:
+          files: utils/build/*
+          fail_on_unmatched_files: true
+          make_latest: true
+          # If we have a tag output from the previous step, use that as the tag
+          # name, otherwise use the current ref which should be the tag.
+          tag_name: ${{ steps.version.outputs.tag || github.ref }}

.gitignore

@@ -1,5 +1,6 @@
 utils/node_modules
 utils/newrelic_agent.log
+utils/build
 
 # IDE files
 .DS_Store
@@ -17,4 +18,4 @@ snapshots/
 yarn.lock
 .yarn-integrity
 yarn-error.log
-utils/yarn-error.log
+utils/yarn-error.log

_template/quickstarts/example-quickstart/config.yml

@@ -44,4 +44,3 @@ documentation:
 
 # Content / Design
 icon: logo.svg
-website: https://www.newrelic.com

alert-policies/mongodb/EmptyDatabase.yml

@@ -13,7 +13,7 @@ valueFunction: SINGLE_VALUE
 terms:
   - priority: CRITICAL
     # Operator used to compare against the threshold.
-    operator: UNDER
+    operator: BELOW
     # Value that triggers a violation
     threshold: 1
     # Time in seconds; 120 - 3600
@@ -23,4 +23,4 @@ terms:
 
 # Duration after which a violation automatically closes
 # Time in seconds; 300 - 2592000 (Default: 86400 [1 day])
-violationTimeLimitSeconds: 86400
+violationTimeLimitSeconds: 86400

data-sources/dbt-cloud/config.yml

@@ -1,5 +1,5 @@
-id: dbt-cloud 
-displayName: dbt Cloud 
+id: dbt-cloud
+displayName: dbt Cloud
 description: |
   Integrates dbt Cloud with New Relic using an Airflow DAG. Our dashboard and alerts help you find issues with dbt Cloud runs and resources.
 icon: logo.png
@@ -8,17 +8,9 @@ install:
     nerdlet:
       nerdletId: marketplace.install-data-source
       nerdletState:
-        dataSourceId: dbt-cloud 
-        frameworkConfigId: dbt-cloud 
+        dataSourceId: dbt-cloud
+        frameworkConfigId: dbt-cloud
       requiresAccount: false
 keywords:
   - dbt cloud
   - dbt
-
-documentation:
-  - name: Github Repository 
-    description: |
-      Github repository with the Airflow DAG and related documentation.
-    url: >-
-      https://github.com/newrelic-experimental/newrelic-dbt-cloud-integration/  
-

quickstarts/ai21-labs/config.yml

@@ -18,8 +18,7 @@ description: |
 summary: |
   Improve the visibility of your AI21 Labs usage with New Relic AI21 Labs quickstart.
 icon: logo.png
-level:
-  - New Relic
+level: New Relic
 authors:
   - New Relic
 title: AI21 Labs

quickstarts/ajax/config.yml

@@ -1,5 +1,4 @@
 id: ab83f4c2-4e75-4767-8dea-fd6ab940a2dd
-displayName: Ajax Requests
 slug: ajax-example
 title: Ajax Requests
 
@@ -30,7 +29,6 @@ description: |
   4.  **Root cause analysis:** Distributed tracing can help you identify the root cause of issues in your microsystem architecture. By tracing the flow of requests, you can identify the root cause of a problem and take steps to prevent similar issues from occurring in the future.
 
 icon: logo.svg
-
 documentation:
   - name: Browser
     description: >-

quickstarts/amazon-bedrock/config.yml

@@ -20,16 +20,15 @@ description: |
 summary: |
   Improve the visibility of your Amazon Bedrock  usage with New Relic Amazon Bedrock  quickstart.
 icon: logo.png
-level:
-  - New Relic
+level: New Relic
 authors:
   - New Relic
   - Jyothi Surampudi
 title: Amazon Bedrock
 documentation:
   - name: Amazon Bedrock integration using Python
     description: |
-      Enhance the performance monitoring and instrumentation of your Amazon Bedrock by using the Python agent. 
+      Enhance the performance monitoring and instrumentation of your Amazon Bedrock by using the Python agent.
     url: https://docs.newrelic.com/install/python
   - name: Amazon Bedrock integration using Node.js
     description: |
@@ -54,4 +53,3 @@ alertPolicies:
   - langchain
 dashboards:
   - langchain
-

quickstarts/anyscale/config.yml

@@ -20,11 +20,10 @@ description: |
 summary: |
   Improve the visibility of your Anyscale usage with New Relic Anyscale quickstart.
 icon: logo.svg
-level:
-  - New Relic
+level: New Relic
 authors:
   - New Relic
-title: Anyscale 
+title: Anyscale
 documentation:
   - name: Anyscale integration documentation
     description: |

quickstarts/apache/config.yml

@@ -25,7 +25,7 @@ summary: |
   Check out New Relic's Apache quickstart and gain a more comprehensive understanding of your servers' performance with customized dashboards including: total requests per second, servers reporting, worker status, and more.
 level: New Relic
 icon: logo.svg
-website: https://httpd.apache.org/
+
 authors:
   - New Relic
   - Jakub Kotkowiak

quickstarts/apdex-optimizer/config.yml

@@ -12,38 +12,38 @@ description: |
   ## 1. Apdex Score Overview:
   - Timeseries chart displaying Apdex scores for each APM application.
   - Highlights performance trends over time.
-  
+
   ## 2. Apdex Breakdown:
   - Detailed breakdown table showcasing Apdex scores for different aspects of your application.
   - Identifies areas of improvement and potential bottlenecks.
-  
+
   ## 3. Transaction-level Insights:
   - In-depth Apdex information on individual transactions.
   - Pinpoints specific transaction performance for focused optimization.
-  
+
   ## 4. Threshold Recommendations:
   - Application Apdex T Value Recommendation table guides optimal threshold settings.
   - Helps fine-tune Apdex parameters for enhanced performance monitoring.
-  
+
   ## 5. Transaction Apdex Values:
   - Transaction Apdex Values table provides granular insights into transaction-level performance.
   - Enables precise adjustments for optimal user satisfaction.
-  
+
   ### Actionable Takeaways:
   - Identify and address performance trends through Apdex score patterns.
   - Optimize specific transactions based on detailed Apdex insights.
   - Fine-tune Apdex thresholds for applications to improve overall monitoring effectiveness.
-  
+
   ### Benefits:
   - Enhanced visibility into application performance.
   - Proactive identification of potential issues.
   - Improved user satisfaction through targeted optimizations.
-  
+
   This comprehensive Apdex Optimizer dashboard empowers you with actionable data to make informed decisions, ensuring your applications perform at their best.
 
 # Displayed in search results and recommendations. Summarizes a quickstarts functionality.
 summary: |
- Comprehensive APM dashboard providing actionable insights, including Apdex scores over time, detailed breakdowns, transaction-level data, and threshold recommendations, empowering users to optimize application performance effectively
+  Comprehensive APM dashboard providing actionable insights, including Apdex scores over time, detailed breakdowns, transaction-level data, and threshold recommendations, empowering users to optimize application performance effectively
 
 # Support level: New Relic | Verified | Community (required)
 level: New Relic
@@ -62,7 +62,7 @@ keywords:
 # Reference to dashboards to be included in this quickstart
 dashboards:
   - apdex-optimizer
-  
+
 # Documentation references
 documentation:
   - name: Apdex
@@ -71,7 +71,6 @@ documentation:
 
 # Content / Design
 icon: logo.svg
-website: https://www.newrelic.com
 
 dataSourceIds:
   - apdex-optimizer

quickstarts/apm-signals/config.yml

@@ -9,37 +9,36 @@ title: APM Signals
 # Long-form description of the quickstart (required)
 description: |
   **APM Signals Dashboard**
-  
+
   ## 1. Traffic:
   - This metric measures the volume of incoming requests to the application. The current throughput, or the number of requests processed per minute, is compared to the previous day's throughput. An increase in throughput suggests a higher demand or traffic on the application compared to the previous day.
-  
+
   ## 2. Latency:
   - Latency refers to the time it takes for a request to be processed by the application. It's typically measured as the average time taken for requests to receive a response. The current average latency is compared to the previous day's average latency. A slightly lower latency indicates a marginal improvement in the application's responsiveness.
-  
+
   ## 3. Errors:
   - Error rate represents the percentage of requests that result in errors or failures. A stable error rate indicates that the application is consistently handling requests without a significant increase in failures compared to the previous day.
-  
+
   ## 4. Apdex:
   - Apdex (Application Performance Index) is a metric that evaluates user satisfaction based on response times. It quantifies users' satisfaction by categorizing response times as satisfactory, tolerable, or frustrating. A high Apdex score, such as 0.96, indicates that the majority of users are experiencing satisfactory response times.
-  
+
   ## 5. Transaction Apdex Values:
   - Transaction Apdex Values table provides granular insights into transaction-level performance.
   - Enables precise adjustments for optimal user satisfaction.
-  
+
   ### Actionable Takeaways:
   - Identify and address performance trends through Apdex score patterns.
   - Optimize specific transactions based on detailed Apdex insights.
   - Fine-tune Apdex thresholds for applications to improve overall monitoring effectiveness.
-  
+
   ### Benefits:
   - Investigating increased traffic and ensuring infrastructure can handle the load.
   - Looking into latency spikes to determine specific events or underlying issues.
   - Monitoring error rates for unusual increases indicating application problems.
-  
 
 # Displayed in search results and recommendations. Summarizes a quickstarts functionality.
 summary: |
- Comprehensive APM dashboard providing actionable insights, including Throughout, Latency, Error Rate & Apdex. 
+  Comprehensive APM dashboard providing actionable insights, including Throughout, Latency, Error Rate & Apdex.
 
 # Support level: New Relic | Verified | Community (required)
 level: New Relic
@@ -59,17 +58,15 @@ keywords:
 # Reference to dashboards to be included in this quickstart
 dashboards:
   - apm-signals
-  
+
 # Documentation references
 documentation:
   - name: apm
     url: https://docs.newrelic.com/docs/apm/apm-monitoring/get-started/get-started-apm-monitoring/
     description: With apm monitoring, modern operations teams get complete observability of complex and hybrid systems, from a datacenter to thousands of Amazon, Google Cloud, or Azure instances.
 
-
 # Content / Design
 icon: logo.svg
-website: https://www.newrelic.com
 
 dataSourceIds:
   - apm-signals

quickstarts/apm-transaction-analysis/config.yaml

@@ -21,6 +21,6 @@ documentation:
     url: https://docs.newrelic.com/docs/apm/transactions/intro-transactions/transactions-new-relic-apm/
     description: Transactions in New Relic's APM
 icon: logo.svg
-website: https://www.newrelic.com
+
 dashboards:
   - apm-transaction-analysis