Metadata-Version: 2.0
Name: datadog-squid
Version: 1.0.1
Summary: The Squid Check
Home-page: https://github.com/DataDog/integrations-core
Author: Datadog
Author-email: packages@datadoghq.com
License: BSD
Keywords: datadog agent squid check
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: System :: Monitoring
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: datadog-checks-base

# Squid Integration

## Overview

This integration lets you monitor your Squid metrics from the Cache Manager directly in Datadog.

## Setup

### Installation

The Agent's Squid check is included in the [Datadog Agent][1] package, so you don't need to install anything else on your Squid server.  

## Configuration

1. Edit the `squid.d/conf.yaml`, in the `conf.d/` folder at the root of your Agent's directory.  
	See the [sample squid.d/conf.yaml][2] for all available configuration options:

    ```yaml
	    init_config:

	    instances:
	      # A list of squid instances identified by their name

      	- name: my_squid
	      #   host: localhost  # The hostname or ip address of the squid server. Default to 'localhost'
	      #   port: 3128  # The port where the squid server is listening. Default to 3128
	      #   tags: ['custom:tag']  # A list of tags that you wish to send with your squid metrics
    ```

2. [Restart the Agent][10] to start sending metrics and service checks to Datadog.

## Validation

[Run the Agent's info subcommand][3] and look for `squid` under the Checks section.

## Data Collected

### Metrics

See [metadata.csv][4]

### Events

The Squid check does not include any events at this time

### Service Checks

**squid.can_connect**:
Returns CRITICAL if the Agent cannot connect to Squid to collect metrics, otherwise OK.

## Troubleshooting

If you have any questions about Datadog or a use case our [Docs][5] didn’t mention, we’d love to help! Here’s how you can reach out to us:

### Visit the Knowledge Base

Learn more about what you can do in Datadog on the [Support Knowledge Base][6].

### Web Support

Messages in the [event stream][7] containing **@support-datadog** will reach our Support Team. This is a convenient channel for referencing graph snapshots or a particular event. In addition, we have a livechat service available during the day (EST) from any page within the app.

### By Email

You can also contact our Support Team via email at [support@datadoghq.com][8].

### Over Slack

Reach out to our team and other Datadog users on [Slack][9].


[1]: https://app.datadoghq.com/account/settings#agent
[2]: https://github.com/DataDog/integrations-core/blob/master/squid/conf.yaml.example
[3]: https://docs.datadoghq.com/agent/faq/agent-commands/#agent-status-and-information
[4]: https://github.com/DataDog/integrations-core/blob/master/squid/metadata.csv
[5]: https://docs.datadoghq.com/
[6]: https://datadog.zendesk.com/agent/
[7]: https://app.datadoghq.com/event/stream
[8]: mailto:support@datadoghq.com
[9]: http://chat.datadoghq.com/
[10]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent


