diff --git a/README.md b/README.md index 69cbe23..f92f462 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,14 @@ -# Datadog Integration Template +#Overview: -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. +API Fortress' DataDog integration is designed to bring your API Fortress test results into DataDog with ease. The process, once set up, is automated. Users can specify either failures only or all test results. Tests that are executed via the scheduler or via external API call will then feed their data into DataDog for visualization. -## Steps +#Setup: -1. Fork this repo +API Fortress' DataDog connecter documentation can be found here: http://apifortress.com/doc/setup-connectors-datadog/ -2. Copy the `Integration` directory to `YourAppName` +By setting up a connector and pushing the data to DataDog, all that remains is to assign the imported data (status.success, status.failure) to the desired dashboard and formatting. - `cp -r Integration YourAppName` +#Metrics: status.success, status.failure, apifortress.latency, apifortress.fetch -3. Create your logo files on a white background canvas, exported to the PNG format, in 3 different sizes: 200x128px, 128x128px and 120x60px. Add the logo images to the `YourAppName/logos/` directory. The file names should be as follows for the different sizes: +#Events: apifortress.events - - **200x128px:** saas_logos-bot.png - - **128x128px:** avatars-bot.png - - **120x60px:** saas_logos-small.png - - -5. Edit `YourAppName/README.md` with your application's information - - Your README file should provide the following sections: - - - **Overview**: Let others know what they can expect to do with your integration - - **Setup**: Provide information about how to install and configure your integration - - **Metrics**: Include a list of the metrics if your integration provides any - - **Events**: Include a list of events if your integration provides any - - **Service Checks**: Include a list of service checks if your integration provides any - - If you want to reference images, please add images into `YourAppName/images/` folder and use the following example to insert image. - - ``` - ![snapshot](https://raw.githubusercontent.com/DataDog/integrations-extras/master/YourAppName/images/snapshot.png) - ``` - **NOTE:** Relative URLs for the images will **not** work. Copy the full URL above and replace `YourAppName` with the correct value. Once your PR has been approved and merged to the master branch, the image will display correctly. - -6. Edit `YourAppName/manifest.json` with your app's details - - This JSON file provides metadata about your integration and should include: - - - **name**: The name of your integration (lowercase) - - **manifest_version**: The version of this manifest file - - **maintainer**: Provide a valid email address where you can be contacted regarding this integration - - **display_name**: The name of your integration - - **short_description**: Provide a description (under 150 characters). This is what populates the hover-over content on the tile - - **metric_prefix**: The root namespace for your metrics, usually the same as the `name` key - - **metric_to_check**: The metric to check if the integration is working or not - - **creates_events**: Boolean true/false, depending on whether your integration sends events or not - - **public_title**: Datadog-YourAppName Integration - - **type:** Either `crawler` or `check`, if your integration is an agent check - - **doc_link**: Link to the documentation page for your integration once it eventually gets published - - **is_public**: **true** (don't change this value) - - **has_logo**: **true** (don't change this value) - - **categories**: Categories to sort your integration, [current categories can be found on integrations dedicated documentation page](https://docs.datadoghq.com/integrations/) - -6. Edit `YourAppName/metadata.csv` to provide metrics you are collecting. Refer to the [this section](https://docs.datadoghq.com/developers/integrations/integration_sdk/#metadata-csv) for further details - -6. Commit your changes, push and submit a pull request - -Send an e-mail to dhruv.sahni@datadoghq.com if you have any questions. diff --git a/integration/logos/avatars-bot.png b/integration/logos/avatars-bot.png index 69a1377..5cf18df 100644 Binary files a/integration/logos/avatars-bot.png and b/integration/logos/avatars-bot.png differ diff --git a/integration/logos/saas_logos-bot.png b/integration/logos/saas_logos-bot.png index 4b422c3..d4019e2 100644 Binary files a/integration/logos/saas_logos-bot.png and b/integration/logos/saas_logos-bot.png differ diff --git a/integration/logos/saas_logos-small.png b/integration/logos/saas_logos-small.png index 39d7a90..d3a4034 100644 Binary files a/integration/logos/saas_logos-small.png and b/integration/logos/saas_logos-small.png differ diff --git a/integration/manifest.json b/integration/manifest.json index 8766637..90dd00e 100644 --- a/integration/manifest.json +++ b/integration/manifest.json @@ -1,16 +1,16 @@ { - "name": "awesomeapp", + "name": "api fortress", "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", + "maintainer": "jason@apifortress.com", + "display_name": "API Fortress", + "short_description": "Automated API Endpoint Testing for the Enterprise", + "metric_prefix": "apifortress.", + "metric_to_check": "apifortress.failure", + "creates_events": true, + "public_title": "Datadog-API Fortress Integration", "type":"check", - "doc_link": "https://docs.datadoghq.com/integrations/awesomeapp/", + "doc_link": "hhttp://apifortress.com/doc/setup-connectors/", "is_public": true, "has_logo": true, - "categories": ["category1", "category2"] + "categories": ["API", "CLOUD", "CONFIGURATION & DEPLOYMENT", "MONITORING"] } diff --git a/metadata.csv b/metadata.csv new file mode 100644 index 0000000..e1e8c64 --- /dev/null +++ b/metadata.csv @@ -0,0 +1,4 @@ +metric_name,metric_type,interval,unit_name,description,orientation,integration,short_name +apifortress.events,,,success,An API Fortress test result event,,,result +apifortress.fetch,,,ms,An API Fortress fetch result,,,fetch +apifortress.latency,,,ms,An API Fortress latency result,,,latency \ No newline at end of file