diff --git a/Integration/CHANGELOG.md b/Integration/CHANGELOG.md deleted file mode 100644 index 5273d59..0000000 --- a/Integration/CHANGELOG.md +++ /dev/null @@ -1,7 +0,0 @@ -# CHANGELOG - AwesomeApp Integration - -1.0.0 / Unreleased -================== -### Changes - -* [FEATURE] Initial AwesomeApp Integration Tile. diff --git a/Integration/README.md b/Integration/README.md deleted file mode 100644 index 1f6100a..0000000 --- a/Integration/README.md +++ /dev/null @@ -1,54 +0,0 @@ -## Overview -**Required.** - -The first thing in the Overview should be a representative image for the integration. Try to make it as interesting as possible. - -The overview section is required and should be a paragraph or two with some bullets of what is interesting about this integration. For example, the following comes from the Docker integration. - -Get metrics from Docker in real time to: - -* Visualize your containers' performance. - -![snapshot](https://raw.githubusercontent.com/DataDog/IntegrationTemplate/master/Integration/images/snapshot.png) - -* Correlate the performance of containers with the applications running inside. - -There are three ways to setup the Docker integration: install the agent on the host, on a single priviledged container, and on each individual container. - -## Setup - -**Required** - -This section should cover anything that you can configure in the Datadog interface or the agent configuration files. Anything that is required to setup the integration should be documented (along with screenshots). - -**Note:** Please avoid linking to an external docs page or PDF file. Instead, copy the documentation here so it becomes easier for your users. - -## Data Collected -### Metrics -See [metadata.csv](https://github.com/DataDog/integrations-extras/blob/master/YourAppName/metadata.csv) for a list of metrics provided by this integration. - -**or** - -The AwesomeApp integration does not provide any metrics at this time. - -### Events - -All AwesomeApp deployment events are sent to your [Datadog Event Stream](https://docs.datadoghq.com/graphing/event_stream/) - -**or** - -The AwesomeApp integration does not include any events at this time. - -### Service Checks -List service checks that the integration provides here - -**or** - -The AwesomeApp integration does not include any service checks at this time. - -## Troubleshooting -Need help? Contact [Datadog Support](http://docs.datadoghq.com/help/). - -## Further Reading - -Learn more about infrastructure monitoring and all our integrations on [our blog](https://www.datadoghq.com/blog/). diff --git a/Integration/images/snapshot.png b/Integration/images/snapshot.png deleted file mode 100644 index a93c253..0000000 Binary files a/Integration/images/snapshot.png and /dev/null differ diff --git a/Integration/logos/avatars-bot.png b/Integration/logos/avatars-bot.png deleted file mode 100644 index 69a1377..0000000 Binary files a/Integration/logos/avatars-bot.png and /dev/null differ diff --git a/Integration/logos/saas_logos-bot.png b/Integration/logos/saas_logos-bot.png deleted file mode 100644 index 4b422c3..0000000 Binary files a/Integration/logos/saas_logos-bot.png and /dev/null differ diff --git a/Integration/logos/saas_logos-small.png b/Integration/logos/saas_logos-small.png deleted file mode 100644 index 39d7a90..0000000 Binary files a/Integration/logos/saas_logos-small.png and /dev/null differ diff --git a/Integration/manifest.json b/Integration/manifest.json deleted file mode 100644 index 3be8597..0000000 --- a/Integration/manifest.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "name": "awesomeapp", - "manifest_version": "1.0.0", - "maintainer": "", - "display_name": "AwesomeApp", - "short_description": "A short blurb about what your app does", - "metric_prefix": "awesomeapp.", - "metric_to_check": "awesomeapp.test", - "creates_events": false, - "public_title": "Datadog-AwesomeApp Integration", - "type":"check", - "doc_link": "https://docs.datadoghq.com/integrations/awesomeapp/", - "is_public": true, - "has_logo": true -} diff --git a/Integration/metadata.csv b/Integration/metadata.csv deleted file mode 100644 index b7fe14e..0000000 --- a/Integration/metadata.csv +++ /dev/null @@ -1,4 +0,0 @@ -metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name -postgresql.connections,gauge,,connection,,The number of active connections to this database.,0,postgres,pg conns -postgresql.commits,gauge,,transaction,second,The number of transactions that have been committed in this database.,0,postgres,pg commits -postgresql.rollbacks,gauge,,transaction,second,The number of transactions that have been rolled back in this database.,-1,postgres,pg rollbacks diff --git a/README.md b/README.md index 755aaef..0ad09a4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ +# Archival +This repo was archived by the Apollo Security team on 2023-05-26. + +This repo is a fork of `DataDog/IntegrationTemplate`. Please refer to the [upstream repo](https://github.com/DataDog/IntegrationTemplate) for newer revisions of this code. + + # Datadog Integration Template Adding an integration tile on to Datadog is easy! Just follow the steps below to use the template from this repo and submit a pull request to get someone from the integrations team to review. diff --git a/apollo-engine/CHANGELOG.md b/apollo-engine/CHANGELOG.md new file mode 100644 index 0000000..078271e --- /dev/null +++ b/apollo-engine/CHANGELOG.md @@ -0,0 +1,7 @@ +# CHANGELOG - Apollo Engine Integration + +1.0.0 / Unreleased +================== +### Changes + +* [FEATURE] Initial Apollo Engine Integration Tile. diff --git a/apollo-engine/README.md b/apollo-engine/README.md new file mode 100644 index 0000000..c6b8120 --- /dev/null +++ b/apollo-engine/README.md @@ -0,0 +1,75 @@ +# Apollo Engine + +## Overview + +Apollo Engine is designed to monitor the performance of your GraphQL infrastructure. If you already have Datadog set up to monitor the rest of your stack, you can easily forward metrics collected by Engine through this integration. + +![Metrics](https://github.com/DataDog/integrations-extras/blob/master/apollo-engine/images/metrics.png) + +The Datadog metrics provided are: + +* `apollo.engine.operations.count` – the number of GraphQL operations that were executed. This includes queries, mutations, and operations that resulted in an error. +* `apollo.engine.operations.error_count`- the number of GraphQL operations that resulted in an error. This includes GraphQL execution errors, and HTTP errors if Engine failed to connect to your server. +* `apollo.engine.operations.cache_hit_count` - the number of GraphQL queries whose result was served from Apollo Engine's full query cache. +* A histogram of GraphQL operation response times, measured in milliseconds. Due to Engine's aggregation method (logarithmic binning), these values are accurate to +/- 5%: + * `apollo.engine.operations.latency.min` + * `apollo.engine.operations.latency.median` + * `apollo.engine.operations.latency.95percentile` + * `apollo.engine.operations.latency.99percentile` + * `apollo.engine.operations.latency.max` + * `apollo.engine.operations.latency.avg` + +All of Engine's Datadog metrics are tagged with the GraphQL operation name, as `operation:`. Unique query signatures with the same operation name are merged, and queries without an operation name are ignored. All of the metrics are also tagged with the Engine service ID, `service:`, so multiple Apollo Engine services can send data to the same Datadog account. + +Engine sends metrics to Datadog in 60 second intervals. Data is forwarded with a 60 second delay to allow for reports from Engine proxies to be collected, even in the case of temporary network failures. +Since Datadog metrics merge statistics from multiple instances of the proxy, per-host metrics are not available. Just like in Apollo Engine, each operation inside a query batch is counted individually. + +## Setup + +### Configuration + +Getting set up with Engine's Datadog integration is as simple as providing a Datadog API key to Engine. There's no further configuration required! + +1. Copy your Datadog API key: + +``` +${api_key} +``` + +2. Navigate to the [Apollo Engine service(s)](https://engine.apollographql.com/) you would like to enable Datadog metrics for. Go to the /settings page for that service: + +![SettingsLink](https://github.com/DataDog/integrations-extras/blob/master/apollo-engine/images/settings-link.png) + +3. You should see an Integrations section at the bottom of the page. Toggle the Datadog integration to turn it on: + +![Settings](https://github.com/DataDog/integrations-extras/blob/master/apollo-engine/images/settings-toggle.png) + +4. Paste the API key, and press **Done**. You can use the same API key for all Apollo Engine services as all metrics are tagged with a service ID (`service:`). + +5. Go to your Datadog metric explorer and start to see the metrics flow in! Please allow up to five minutes for metrics to be visible. + +### Usage + +Please refer to the [Apollo Engine docs](https://www.apollographql.com/docs/engine/datadog.html) for more detailed usage information. + +## Data Collected + +### Metrics + +See [metadata.csv](https://github.com/DataDog/integrations-extras/blob/master/apollo-engine/metadata.csv) for a list of metrics provided by this integration. + +### Events + +The Apollo Engine integration does not include any events at this time. + +### Service Checks + +The Apollo Engine integration does not include any service checks at this time. + +## Troubleshooting + +Need help? Contact [Datadog Support](http://docs.datadoghq.com/help/). + +## Further Reading + +Learn more about infrastructure monitoring and all our integrations on [our blog](https://www.datadoghq.com/blog/). diff --git a/apollo-engine/images/metrics.png b/apollo-engine/images/metrics.png new file mode 100644 index 0000000..4f31397 Binary files /dev/null and b/apollo-engine/images/metrics.png differ diff --git a/apollo-engine/images/settings-link.png b/apollo-engine/images/settings-link.png new file mode 100644 index 0000000..d58c0a3 Binary files /dev/null and b/apollo-engine/images/settings-link.png differ diff --git a/apollo-engine/images/settings-toggle.png b/apollo-engine/images/settings-toggle.png new file mode 100644 index 0000000..932eda5 Binary files /dev/null and b/apollo-engine/images/settings-toggle.png differ diff --git a/apollo-engine/logos/avatars-bot.png b/apollo-engine/logos/avatars-bot.png new file mode 100644 index 0000000..2ff1cc9 Binary files /dev/null and b/apollo-engine/logos/avatars-bot.png differ diff --git a/apollo-engine/logos/saas_logos-bot.png b/apollo-engine/logos/saas_logos-bot.png new file mode 100644 index 0000000..7755162 Binary files /dev/null and b/apollo-engine/logos/saas_logos-bot.png differ diff --git a/apollo-engine/logos/saas_logos-small.png b/apollo-engine/logos/saas_logos-small.png new file mode 100644 index 0000000..113c487 Binary files /dev/null and b/apollo-engine/logos/saas_logos-small.png differ diff --git a/apollo-engine/manifest.json b/apollo-engine/manifest.json new file mode 100644 index 0000000..799bd40 --- /dev/null +++ b/apollo-engine/manifest.json @@ -0,0 +1,16 @@ +{ + "name": "apollo-engine", + "manifest_version": "1.0.0", + "maintainer": "martijnwalraven@apollographql.com", + "display_name": "Apollo Engine", + "short_description": "Monitor the performance of your GraphQL infrastructure", + "metric_prefix": "apollo.engine.", + "metric_to_check": "apollo.engine.operations.count", + "creates_events": false, + "public_title": "Datadog-Apollo Engine Integration", + "categories":["api", "monitoring", "caching"], + "type": "crawler", + "doc_link": "https://docs.datadoghq.com/integrations/apollo-engine/", + "is_public": true, + "has_logo": true +} diff --git a/apollo-engine/metadata.csv b/apollo-engine/metadata.csv new file mode 100644 index 0000000..cc4464c --- /dev/null +++ b/apollo-engine/metadata.csv @@ -0,0 +1,10 @@ +metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name +apollo.engine.operations.count,gauge,,operation,,"Number of GraphQL operations (query, mutation) processed.",0,apollo_engine,Operation count +apollo.engine.operations.latency.avg,gauge,,millisecond,,"Total request duration for a GraphQL operation, average.",-1,apollo_engine,Average latency +apollo.engine.operations.latency.median,gauge,,millisecond,,"Total request duration for a GraphQL operation, median/50th percentile.",-1,apollo_engine,Median latency +apollo.engine.operations.latency.95percentile,gauge,,millisecond,,"Total request duration for a GraphQL operation, 95th percentile.",-1,apollo_engine,P95 latency +apollo.engine.operations.latency.99percentile,gauge,,millisecond,,"Total request duration for a GraphQL operation, 99th percentile.",-1,apollo_engine,P99 Latency +apollo.engine.operations.latency.max,gauge,,millisecond,,"Total request duration for a GraphQL operation, max/100th percentile.",-1,apollo_engine,Max latency +apollo.engine.operations.latency.min,gauge,,millisecond,,"Total request duration for a GraphQL operation, min/0th percentile.",-1,apollo_engine,Min latency +apollo.engine.operations.error_count,gauge,,error,,"Number of GraphQL operations that resulted in a GraphQL error, including HTTP errors from origins.",-1,apollo_engine,Error count +apollo.engine.operations.cache_hit_count,gauge,,hit,,Number of GraphQL queries that were served from the full response cache.,1,apollo_engine,Cache hit count \ No newline at end of file