Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Artifact creation and validation #2540

Merged
merged 37 commits into from
Sep 9, 2024
Merged
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
0311ab2
WIP: Creating and validating artifact
Aug 29, 2024
68085ff
WIP: Cleanup
Aug 29, 2024
d1a7f25
feat: Update schema validation
Sep 3, 2024
bcc7ab4
fix: Properly get all datasource definitions
Sep 3, 2024
1e6e183
feat: First pass at error output
Sep 3, 2024
1de35c9
feat: Add community dataSourceIds
Sep 3, 2024
0cabd35
refactor: Rename datasource to dataSource
Sep 3, 2024
0b0ad40
feat: Additional error output formatting
Sep 3, 2024
1be1bd8
WIP: Creating and validating artifact
Aug 29, 2024
c5107b6
WIP: Cleanup
Aug 29, 2024
556b9cd
fix: Properly get all datasource definitions
Sep 3, 2024
76d9594
feat: First pass at error output
Sep 3, 2024
e9ef407
feat: Add community dataSourceIds
Sep 3, 2024
b1c5eb6
refactor: Rename datasource to dataSource
Sep 3, 2024
3a4ddf7
feat: Additional error output formatting
Sep 3, 2024
82ccc25
chore: Resolving merge conflicts
zstix Sep 5, 2024
5343088
refactor: Broke up large script to smaller, composable, functions
zstix Sep 5, 2024
5338b6b
feat: Fix configs for validation
mickeyryan42 Sep 5, 2024
ec3ceb6
feat: Fix config issues for validation
mickeyryan42 Sep 5, 2024
3e48902
feat: Remove extra filter
Sep 5, 2024
0ee8e1f
refactor: Minor cleanup with error parsing
Sep 5, 2024
0c3e0e6
fix: Correctly fetch all alerts
Sep 6, 2024
84cfe43
chore: Move comment to the right place
Sep 6, 2024
9fbe659
fix: Correct mongo operator
Sep 6, 2024
a54677a
feat: Update alerts schema
Sep 6, 2024
912a627
chore: Remove debug log
Sep 6, 2024
162893d
Merge branch 'campfire/NR-268461-config-fixes' of https://github.com/…
mickeyryan42 Sep 6, 2024
6c44419
refactor: Add a type guard function to remove the need for `as`
zstix Sep 6, 2024
8bb1b46
chore: Reverted flexibility with install directives
zstix Sep 6, 2024
ebb74da
chore: Show a success message when script encounters no errors
zstix Sep 6, 2024
533e844
refactor: Pull in lodash/get to make access to nested object easier
zstix Sep 6, 2024
9c39df9
chore: Remove unecessary whitespace
zstix Sep 6, 2024
2669874
chore: Slightly less permissive types
zstix Sep 6, 2024
ba9fc77
refactor: Separated error formatting from printing
zstix Sep 6, 2024
c10fc26
test: Ensure logic is correct for building and validating artifact
zstix Sep 6, 2024
1823bef
Merge branch 'campfire/NR-268461-build-validate-artifact' of https://…
mickeyryan42 Sep 9, 2024
a8d98bf
test: Add alert and dashboard to tests
mickeyryan42 Sep 9, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion _template/quickstarts/example-quickstart/config.yml
Original file line number Diff line number Diff line change
@@ -44,4 +44,3 @@ documentation:

# Content / Design
icon: logo.svg
website: https://www.newrelic.com
4 changes: 2 additions & 2 deletions alert-policies/mongodb/EmptyDatabase.yml
Original file line number Diff line number Diff line change
@@ -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
16 changes: 4 additions & 12 deletions data-sources/dbt-cloud/config.yml
Original file line number Diff line number Diff line change
@@ -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/

3 changes: 1 addition & 2 deletions quickstarts/ai21-labs/config.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 0 additions & 2 deletions quickstarts/ajax/config.yml
Original file line number Diff line number Diff line change
@@ -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: >-
6 changes: 2 additions & 4 deletions quickstarts/amazon-bedrock/config.yml
Original file line number Diff line number Diff line change
@@ -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

5 changes: 2 additions & 3 deletions quickstarts/anyscale/config.yml
Original file line number Diff line number Diff line change
@@ -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: |
2 changes: 1 addition & 1 deletion quickstarts/apache/config.yml
Original file line number Diff line number Diff line change
@@ -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
19 changes: 9 additions & 10 deletions quickstarts/apdex-optimizer/config.yml
Original file line number Diff line number Diff line change
@@ -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
21 changes: 9 additions & 12 deletions quickstarts/apm-signals/config.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion quickstarts/apm-transaction-analysis/config.yaml
Original file line number Diff line number Diff line change
@@ -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
1 change: 0 additions & 1 deletion quickstarts/apollo/apollo-server/config.yml
Original file line number Diff line number Diff line change
@@ -48,4 +48,3 @@ documentation:
url: https://github.com/newrelic/newrelic-node-apollo-server-plugin/blob/main/README.md
description: New Relic's official Apollo Server plugin for use with the Node.js agent.
icon: logo.png
website: https://www.apollographql.com/
2 changes: 1 addition & 1 deletion quickstarts/atlassian/atlassian-jira/config.yml
Original file line number Diff line number Diff line change
@@ -41,6 +41,6 @@ keywords:

# Content / Design
icon: logo.png
website: https://www.atlassian.com/

dataSourceIds:
- atlassian-jira
2 changes: 1 addition & 1 deletion quickstarts/atlassian/bitbucket/config.yml
Original file line number Diff line number Diff line change
@@ -37,6 +37,6 @@ documentation:
url: https://bitbucket.org/product/features/pipelines/integrations?p=jcountsnr/newrelic_observability_event
description: Bitbucket pipe integration to send an event to New Relic from your Bitbucket pipeline.
icon: logo.svg
website: https://bitbucket.org/

dashboards:
- bitbucket
Original file line number Diff line number Diff line change
@@ -31,7 +31,6 @@ documentation:
description: |
New Relic Data Management Hub
icon: logo.svg
website: https://www.newrelic.com
dashboards:
- aws-integrations-data-ingest-analysis
- azure-integrations-data-ingest-analysis
1 change: 0 additions & 1 deletion quickstarts/audit/log-ingestion-analysis/config.yml
Original file line number Diff line number Diff line change
@@ -23,6 +23,5 @@ documentation:
description: |
New Relic offers a fast, scalable log management platform so you can connect your logs with the rest of your telemetry and infrastructure data in a single place.
icon: logo.svg
website: https://www.newrelic.com
dashboards:
- log-analysis
5 changes: 2 additions & 3 deletions quickstarts/awadb/config.yml
Original file line number Diff line number Diff line change
@@ -17,8 +17,7 @@ description: |
summary: |
Monitor your Vector search's performance and quality with New Relic AwaDB quickstart
icon: logo.png
level:
- New Relic
level: New Relic
authors:
- New Relic
- Ramana Reddy
@@ -43,4 +42,4 @@ keywords:
alertPolicies:
- langchain-vectordb
dashboards:
- langchain-vectordb
- langchain-vectordb
1 change: 0 additions & 1 deletion quickstarts/aws/amazon-mwaa/config.yml
Original file line number Diff line number Diff line change
@@ -54,4 +54,3 @@ documentation:

# Content / Design
icon: logo.svg
website: https://www.newrelic.com
10 changes: 5 additions & 5 deletions quickstarts/azure/azure-event-grid-topics/config.yml
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@ description: |-
## What is Azure Event Grid Topics?

Event Grid is a highly scalable, serverless event broker that you can use to integrate applications using events. Event Grid topic provides an endpoint where the source sends events. A topic is used for a collection of related events. To respond to certain types of events, subscribers decide which topics to subscribe to.

### New Relic Azure Event Grid Topics quickstart features

A standard dashboard that tracks key indicators like delivery success count, matched event count, publish success count. It runs custom queries and visualizes the data immediately.
@@ -13,10 +13,10 @@ description: |-
### Why monitor Azure Event Grid Topics with New Relic?

[New Relic Azure Event Grid Topics](https://docs.newrelic.com/docs/infrastructure/microsoft-azure-integrations/azure-integrations-list/azure-event-grid-topics-monitoring-integration/) monitoring quickstart empowers you to track the performance of Azure Batch via different metrics including delivery success count, matched event count, publish success count.

Our integration features a standard dashboard that provides interactive visualizations to explore your data, understand context and get valuable insights.
Start ingesting your Azure data today and get immediate access to our visualization dashboards so you can optimize your Azure service.

Start ingesting your Azure data today and get immediate access to our visualization dashboards so you can optimize your Azure service.
summary: |-
Monitoring Azure Event Grid Topics is critical to track the performance through key metrics. Download New Relic Azure Event Grid Topics monitoring quickstart to get a pre-built dashboard tailored to monitor your Azure Event Grid Topics Service.
icon: logo.png
@@ -40,5 +40,5 @@ keywords:
- NR1_sys
dashboards:
- azure-event-grid-topics
dataSourceIDs:
dataSourceIds:
- azure-monitor
2 changes: 1 addition & 1 deletion quickstarts/battlesnake/config.yml
Original file line number Diff line number Diff line change
@@ -27,7 +27,7 @@ keywords:
- snake
- battlesnake
icon: logo.png
website: https://play.battlesnake.com

dashboards:
- battlesnake-game-tracking
- battlesnake-performance
1 change: 0 additions & 1 deletion quickstarts/biztalk360/config.yml
Original file line number Diff line number Diff line change
@@ -60,6 +60,5 @@ documentation:
description: |
BizTalk360 brings integration with New Relic and has the capability to provide deep performance analytics of your configured BizTalk environment.
icon: logo.png
website: https://www.biztalk360.com/
dashboards:
- biztalk360
1 change: 0 additions & 1 deletion quickstarts/blazemeter/config.yml
Original file line number Diff line number Diff line change
@@ -70,4 +70,3 @@ documentation:

# Content / Design
icon: logo.png
website: https://www.blazemeter.com/
1 change: 0 additions & 1 deletion quickstarts/boomi/config.yaml
Original file line number Diff line number Diff line change
@@ -27,4 +27,3 @@ documentation:
url: https://help.boomi.com/docs/atomsphere/flow/topics/flo-observability_collector_8b3010e3-51b1-43b5-8b09-9575e59610b0/#setting-up-the-apm-system-new-relic
description: Docs for setting up an OpenTelemetry collector to send Traces from Boomi to New Relic
icon: logo.png
website: https://boomi.com/
2 changes: 1 addition & 1 deletion quickstarts/browser-segment-investigation/config.yml
Original file line number Diff line number Diff line change
@@ -22,6 +22,6 @@ documentation:
dataSourceIds:
- browser-segment-investigation
icon: logo.svg
website: https://www.newrelic.com

dashboards:
- browser-segment-investigation
Loading