Skip to content

Commit

Permalink
DOCS-2530 Lint Integrations section (part 2) (DataDog#1110)
Browse files Browse the repository at this point in the history
  • Loading branch information
ruthnaebeck authored Jan 3, 2022
1 parent 8ed64da commit 4f3c5b3
Show file tree
Hide file tree
Showing 11 changed files with 27 additions and 31 deletions.
8 changes: 4 additions & 4 deletions calico/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Using annotations:

1. Set up Calico on your cluster if you have not already.

2. Enable Prometheus metrics using the instructions in Calico's [Monitor Calico Component Metrics documentation][9].
2. Enable Prometheus metrics using the instructions in [Monitor Calico component metrics][9].
Once enabled, you should have a `felix-metrics-svc` service running in your cluster, as well as a `prometheus-pod`.

3. To use Autodiscovery, modify `prometheus-pod`. Add the following snippet to your Prometheus YAML configuration file:
Expand Down Expand Up @@ -56,7 +56,7 @@ To install the Calico check on your host:
4. Upload the build artifact to any host with an Agent and
run `datadog-agent integration install -w path/to/calico/dist/<ARTIFACT_NAME>.whl`.

5. Follow Calico's [Monitor Calico Component Metrics documentation][9] until you have a `felix-metrics-svc` service running using `kubectl get all --all-namespaces`.
5. Follow [Monitor Calico component metrics][9] until you have a `felix-metrics-svc` service running using `kubectl get all --all-namespaces`.

6. If you are using minikube, you must forward port 9091 to `felix-metrics-svc`.
Run `kubectl port-forward service/felix-metrics-svc 9091:9091 -n kube-system`.
Expand Down Expand Up @@ -92,8 +92,8 @@ See [service_checks.json][7] for a list of service checks provided by this integ

## Concerning logs

Since Calico structure is setup in a kubernetes cluster, it is built with deployments, pods, service.
Kubernetes integration makes a great job at fetching logs from containers Therefore, when Kubernetes integration is setup, calico logs are automatically available in datadoghq Log section. You should proceed this way.
Since Calico structure is set up in a Kubernetes cluster, it is built with deployments, pods, and services.
The Kubernetes integration fetches logs from containers. Therefore, when Kubernetes integration is set up, Calico logs are automatically available in the Datadog Log Explorer.

## Troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion concourse_ci/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Configure ATC to use the Datadog emitter by setting the following options. It is

### Metric emitter options

See the Concourse CI [documentation][4] for more information.
See [Configuring Metrics][4] in the Concourse CI documentation for more information.

```text
Metric Emitter (Datadog):
Expand Down
4 changes: 2 additions & 2 deletions configcat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ ConfigCat integration does not include any service checks.

## Troubleshooting

Need help? See the [ConfigCat documentation][6] or contact [ConfigCat support][7]
Need help? See the [ConfigCat documentation][6] or contact [ConfigCat support][7].

[1]: https://raw.githubusercontent.com/DataDog/integrations-extras/master/configcat/images/datadog_apikey.png
[2]: https://configcat.com
Expand All @@ -56,4 +56,4 @@ Need help? See the [ConfigCat documentation][6] or contact [ConfigCat support][7
[8]: https://www.datadoghq.com
[9]: https://docs.datadoghq.com/account_management/api-app-keys/#api-keys
[10]: https://app.configcat.com/product/integrations
[11]: https://github.com/configcat
[11]: https://github.com/configcat
8 changes: 4 additions & 4 deletions contrastsecurity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ The Datadog-Contrast integration allows you to get your Contrast logs into Datad

## Setup

### Log Collection
### Log collection

Enable logs collection for Datadog Agent in `/etc/datadog-agent/datadog.yaml` on Linux platforms. On other platforms, refer to the [Agent Configuration Files guide][1] for the location of your configuration file:
Enable logs collection for Datadog Agent in `/etc/datadog-agent/datadog.yaml` on Linux platforms. On other platforms, see the [Agent Configuration Files guide][1] for the location of your configuration file:

```yaml
logs_enabled: true
Expand All @@ -32,7 +32,7 @@ For more information on logs, see the [Contrast Security documentation][2].

For more information, see the:
- [Datadog Logs documentation][4]
- [Datadog API documentation for creating a dashboard][5]
- [Datadog Dashboards API][5]

## Data Collected

Expand All @@ -52,5 +52,5 @@ The Contrast integration does not include any service checks.
[1]: https://docs.datadoghq.com/agent/guide/agent-configuration-files/
[2]: https://docs.contrastsecurity.com/
[3]: https://docs.datadoghq.com/agent/guide/agent-commands/#restart-the-agent
[4]: https://docs.datadoghq.com/logs/log_collection/#getting-started-with-the-agent
[4]: https://docs.datadoghq.com/logs/log_collection/
[5]: https://docs.datadoghq.com/api/#create-a-dashboard
4 changes: 2 additions & 2 deletions convox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Get metrics from Convox in real-time to visualize your containers' performance:

## Setup

Please refer to the [Convox setup doc page][2].
See the Convox documentation to [set up Datadog][2].

### Deploy the Datadog Agent

Expand All @@ -30,7 +30,7 @@ Use a `count` that matches the `InstanceCount` parameter of your Rack.

### Auto scaling

If autoscaling is enabled on your Rack, you'll need to dynamically scale the Datadog agent count to match the Rack instance count.
If autoscaling is enabled on your Rack, you need to dynamically scale the Datadog Agent count to match the Rack instance count.

See the [Listening for ECS CloudWatch Events Tutorial][3] for guidance.

Expand Down
11 changes: 3 additions & 8 deletions embrace_mobile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

## Overview

### What is Embrace?

[Embrace][1] is a mobile observability and data platform that empowers mobile teams to deliver optimal user experiences for
performance optimization, issue prioritization and remediation, and monitoring across features, releases, and custom
segments. At its core, Embrace turns complex mobile data into action. By collecting comprehensive session-level data for
Expand All @@ -12,21 +10,18 @@ each and every user experience, Embrace extracts powerful insights to fuel your
After app installation, Embrace provides dashboards that track key mobile health metrics. For any regression, you can inspect
the full details of every affected user session without having to manually reproduce it.


## Setup

1. Start a free trial with Embrace and follow our [documentation here][2]. **You’ll need to
follow this documentation before seeing metrics in Datadog.**
1. Start a free trial and follow the [Embrace documentation][2]. **You need to follow this documentation before seeing metrics in Datadog.**
1. After completing setup of the Embrace integration, navigate back to Datadog to connect both platforms.
1. Authenticate and connect your Embrace account to Datadog by logging in with your credentials.
1. Create a New Dashboard in Datadog. Select the Embrace widget to display Embrace data with crash or networking metrics.
1. Click into “Details” to dive deeper into Embrace from Datadog.

## Support
For support or questions, contact [Datadog support][3].

Additional Embrace documentation is available [here][2].
Need help? Contact [Datadog support][3].

[1]: https://embrace.io
[2]: https://embrace.io/docs/
[3]: https://www.datadoghq.com/support/
[3]: https://docs.datadoghq.com/help/
2 changes: 1 addition & 1 deletion fairwinds_insights/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Fairwinds Insights uncovers issues in your Kubernetes clusters related to Securi

## Setup

You'll need to have an account at insights.fairwinds.com to use this app. You can also sign up for Fairwinds
You need to have an account at insights.fairwinds.com to use this app. You can also sign up for Fairwinds
Insights in the Datadog Marketplace.

Once your account is set up, you can add this app to any Datadog dashboard.
Expand Down
2 changes: 1 addition & 1 deletion fairwinds_insights/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"overview": "README.md#Overview",
"configuration": "README.md#Setup",
"support": "README.md#Support",
"description": "Fairwinds Insights protects and optimizes your mission-critical Kubernetes applications",
"description": "Protects and optimizes your mission-critical Kubernetes applications",
"title": "Fairwinds Insights",
"media": [
{
Expand Down
6 changes: 3 additions & 3 deletions federatorai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Using advanced machine learning algorithms to predict application workloads, Fed
* Multicloud cost analysis and recommendations based on workload predictions for Kubernetes clusters and VM clusters
* Actual cost and potential savings based on recommendations for clusters, Kubernetes applications, VMs, and Kubernetes namespaces

By integrating with ProphetStor Federator.ai, you can track and predict the resource usages of Kubernetes containers, namespaces, and cluster nodes to make the right recommendations to prevent costly over-provisioning or performance-impacting under-provisioning. With easy integration to CI/CD pipeline, Federator.ai enables continuous optimization of containers whenever they are deployed in a Kubernetes cluster. Utilizing application workload predictions, Federator.ai auto-scales application containers at the right time and optimizes performance with the right number of container replicas through Kubernetes HPA or [Datadog Watermark Pod Autoscaling (WPA)][3].
By integrating with ProphetStor Federator.ai, you can track and predict the resource usages of Kubernetes containers, namespaces, and cluster nodes to make the right recommendations to prevent costly over-provisioning or performance-impacting under-provisioning. With easy integration to CI/CD pipeline, Federator.ai enables continuous optimization of containers whenever they are deployed in a Kubernetes cluster. Using application workload predictions, Federator.ai auto-scales application containers at the right time and optimizes performance with the right number of container replicas through Kubernetes HPA or [Datadog Watermark Pod Autoscaling (WPA)][3].

For additional information on Federator.ai, refer to the [ProphetStor Federator.ai Feature Demo][2] and [ProphetStor Federator.ai for Datadog][14] videos.
For additional information on Federator.ai, see the [ProphetStor Federator.ai Feature Demo][2] and [ProphetStor Federator.ai for Datadog][14] videos.


**ProphetStor Federator.ai Cluster Overview**
Expand Down Expand Up @@ -231,7 +231,7 @@ For additional information on Federator.ai, refer to the [ProphetStor Federator.

![Add Cluster Window][4]

3. Refer to the [Federator.ai - Installation and Configuration Guide][6] and [User Guide][5] for more details.
3. See the [Federator.ai - Installation and Configuration Guide][6] and [User Guide][5] for more details.


## Data Collected
Expand Down
2 changes: 1 addition & 1 deletion filebeat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ For Agent v7.21+ / v6.21+, follow the instructions below to install the Filebeat

## Validation

[Run the Agent's `status` subcommand][10] and look for `filebeat` under the Checks section.
Run the [Agent's status subcommand][10] and look for `filebeat` under the Checks section.

## Data Collected

Expand Down
9 changes: 5 additions & 4 deletions flagsmith/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,18 @@ The Flagsmith integration does not include any metrics.

### Service Checks

Flagsmith does not include any service checks.
The Flagsmith integration does not include any service checks.

### Events

All events are sent to the Datadog event stream.
All Flagsmith events are sent to the Datadog event stream.

## Troubleshooting

Need help? Check out the [Flagsmith documentation](https://docs.flagsmith.com/integrations/datadog/) or [contact Datadog Support][4].
Need help? See the [Flagsmith documentation][4] or contact [Datadog Support][5].

[1]: https://www.flagsmith.com/
[2]: https://app.datadoghq.com/account/settings#integrations/flagsmith
[3]: https://app.datadoghq.com/organization-settings/api-keys
[4]: https://docs.datadoghq.com/help/
[4]: https://docs.flagsmith.com/integrations/datadog/
[5]: https://docs.datadoghq.com/help/

0 comments on commit 4f3c5b3

Please sign in to comment.