--- title: Squid description: Track metrics from your squid-cache servers with Datadog breadcrumbs: Docs > Integrations > Squid --- # Squid Supported OS Integration version5.4.0 Squid - 1Squid - 2 ## Overview{% #overview %} [Squid](http://www.squid-cache.org/) is an open-source caching and forwarding web proxy server that operates as an intermediary between clients and servers on a network. It acts as a gateway, enabling clients to access various internet resources such as websites, files, and other content from servers. This integration provides enrichment and visualization for Squid logs. It helps you visualize detailed insights into Squid log analysis through the out-of-the-box dashboards and detection rules, enhancing detection and response capabilities. Additionally, it includes pre-configured monitors for proactive notifications on the following: 1. High rate of server errors 1. CPU usage exceeded 1. High latency requests 1. High rate of client HTTP errors This check monitors [Squid](http://www.squid-cache.org/) metrics from the Cache Manager through the Datadog Agent. **Minimum Agent version:** 6.0.0 ## Setup{% #setup %} ### Installation{% #installation %} The Agent's Squid check is included in the [Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest) package. No additional installation is needed on your Squid server. ### Configuration{% #configuration %} {% tab title="Host" %} #### Host{% #host %} To configure this check for an Agent running on a host: ##### Metric collection{% #metric-collection %} 1. Edit the `squid.d/conf.yaml`, in the `conf.d/` folder at the root of your [Agent's configuration directory](https://docs.datadoghq.com/agent/guide/agent-configuration-files.md#agent-configuration-directory). See the [sample squid.d/conf.yaml](https://github.com/DataDog/integrations-core/blob/master/squid/datadog_checks/squid/data/conf.yaml.example) for all available configuration options. 1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands.md#start-stop-and-restart-the-agent). ##### Log collection{% #log-collection %} *Available for Agent versions >6.0* 1. Collecting logs is disabled by default in the Datadog Agent, enable it in your `datadog.yaml` file: ```yaml logs_enabled: true ``` 1. Uncomment and edit this configuration block at the bottom of your `squid.d/conf.yaml` file: ```yaml logs: - type: file path: /var/log/squid/cache.log service: "" source: squid - type: file path: /var/log/squid/access.log service: "" source: squid ``` Change the `path` and `service` parameter values and configure them for your environment. 1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands.md#start-stop-and-restart-the-agent). {% /tab %} {% tab title="Containerized" %} #### Containerized{% #containerized %} For containerized environments, see the [Autodiscovery Integration Templates](https://docs.datadoghq.com/agent/kubernetes/integrations.md) for guidance on applying the parameters below. ##### Metric collection{% #metric-collection %} | Parameter | Value | | -------------------- | ---------------------------------------------------------------------- | | `` | `squid` | | `` | blank or `{}` | | `` | `{"name": "", "host": "%%host%%", "port":"3128"}` | ##### Log collection{% #log-collection %} *Available for Agent versions >6.0* Collecting logs is disabled by default in the Datadog Agent. To enable it, see [Kubernetes Log Collection](https://docs.datadoghq.com/agent/kubernetes/log.md?tab=containerinstallation#setup). | Parameter | Value | | -------------- | --------------------------------------------------- | | `` | `{"source": "squid", "service": ""}` | {% /tab %} ### Validation{% #validation %} [Run the Agent's status subcommand](https://docs.datadoghq.com/agent/guide/agent-commands.md#agent-status-and-information) and look for `squid` under the Checks section. ## Data Collected{% #data-collected %} ### Logs{% #logs %} The Squid integration collects access and cache logs. #### Supported Access Log Formats{% #supported-access-log-formats %} | Name | Format Specification | | -------- | ---------------------------------------------------------------------------------------- | | squid | `%ts.%03tu %6tr %>a %Ss/%03>Hs %a - %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %a - %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %h" "%{User-Agent}>h" %Ss:%Sh` | For more information, refer to [Squid log formats](https://www.squid-cache.org/Doc/config/logformat/). **Note**: The default `logformat` type is `squid`. You can update the supported log format in `/etc/squid/squid.conf`, then restart Squid. To use the `combined` type for `logformat`, add the following lines to your `/etc/squid/squid.conf` file: ```gdscript3 logformat combined %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %h" "%{User-Agent}>h" %Ss:%Sh access_log /var/log/squid/access.log combined ``` Next, restart the `squid` service using the following command: ```shell sudo systemctl restart squid ``` **Note**: - The `Top Avg Request Duration by URL Host` panel will be loaded only if the default `squid` type of `logformat` is configured. - The `Top Browsers` and `Top HTTP Referrer` panels will be loaded only if the `combined` type of `logformat` is configured. ### Metrics{% #metrics %} | | | | | **squid.cachemgr.aborted\_requests**(gauge) | The number of server-side HTTP requests aborted due to client-side aborts.*Shown as request* | | **squid.cachemgr.cd.kbytes\_recv**(gauge) | The amount of traffic received from neighbors in Cache Digest messages.*Shown as kibibyte* | | **squid.cachemgr.cd.kbytes\_sent**(gauge) | The amount of traffic sent to neighbors in Cache Digest messages.*Shown as kibibyte* | | **squid.cachemgr.cd.local\_memory**(gauge) | The amount of memory used to store Squid's own Cache Digest.*Shown as kibibyte* | | **squid.cachemgr.cd.memory**(gauge) | The amount of memory used by enabling the Cache Digests' feature.*Shown as kibibyte* | | **squid.cachemgr.cd.msgs\_recv**(gauge) | The number of Cache Digest messages received from neighbors.*Shown as message* | | **squid.cachemgr.cd.msgs\_sent**(gauge) | The number of Cache Digest messages sent to neighbors.*Shown as message* | | **squid.cachemgr.cd.times\_used**(gauge) | The number of times Cache Digests resulted in the selection of a neighbor as the next-hop for a cache miss. | | **squid.cachemgr.client\_http.errors**(gauge) | The number of client transactions that resulted in an error.*Shown as error* | | **squid.cachemgr.client\_http.hit\_kbytes\_out**(gauge) | The amount of traffic sent to clients in responses that are cache hits*Shown as kibibyte* | | **squid.cachemgr.client\_http.hits**(gauge) | The number of cache hits in response to client requests.*Shown as hit* | | **squid.cachemgr.client\_http.kbytes\_in**(gauge) | The amount of traffic received from clients in their requests.*Shown as kibibyte* | | **squid.cachemgr.client\_http.kbytes\_out**(gauge) | The amount of traffic sent to clients in responses.*Shown as kibibyte* | | **squid.cachemgr.client\_http.requests**(gauge) | The number of HTTP requests received from clients*Shown as request* | | **squid.cachemgr.cpu\_time**(gauge) | The amount of CPU used by squid, as reported by getrusage( ).*Shown as percent* | | **squid.cachemgr.icp.kbytes\_recv**(gauge) | The amount of traffic received in all ICP messages, including both queries and replies.*Shown as kibibyte* | | **squid.cachemgr.icp.kbytes\_sent**(gauge) | The amount of traffic sent in all ICP messages, including both queries and replies.*Shown as kibibyte* | | **squid.cachemgr.icp.pkts\_recv**(gauge) | The number of ICP messages received from neighbors, including both queries and replies*Shown as message* | | **squid.cachemgr.icp.pkts\_sent**(gauge) | The number of ICP messages sent to neighbors. This includes both queries and replies but doesn't include HTCP messages.*Shown as message* | | **squid.cachemgr.icp.q\_kbytes\_recv**(gauge) | The amount of traffic received from neighbors in ICP queries.*Shown as kibibyte* | | **squid.cachemgr.icp.q\_kbytes\_sent**(gauge) | The amount of traffic sent to neighbors in ICP queries.*Shown as kibibyte* | | **squid.cachemgr.icp.queries\_recv**(gauge) | The number of ICP queries received from neighbors.*Shown as query* | | **squid.cachemgr.icp.queries\_sent**(gauge) | The number of ICP queries sent to neighbors.*Shown as query* | | **squid.cachemgr.icp.query\_timeouts**(gauge) | The number of times that Squid timed out waiting for ICP replies to arrive.*Shown as error* | | **squid.cachemgr.icp.r\_kbytes\_recv**(gauge) | The amount of traffic received from neighbors in ICP replies.*Shown as kibibyte* | | **squid.cachemgr.icp.r\_kbytes\_sent**(gauge) | The amount of traffic sent to neighbors in ICP replies.*Shown as kibibyte* | | **squid.cachemgr.icp.replies\_queued**(gauge) | The number of times Squid queued an ICP message after the initial attempt to send failed.*Shown as message* | | **squid.cachemgr.icp.replies\_recv**(gauge) | The number of ICP replies received from neighbors.*Shown as response* | | **squid.cachemgr.icp.replies\_sent**(gauge) | The number of ICP replies sent to neighbors.*Shown as response* | | **squid.cachemgr.icp.times\_used**(gauge) | The number of times ICP resulted in the selection of a neighbor as the next-hop for a cache miss. | | **squid.cachemgr.page\_faults**(gauge) | The number of (major) page faults as reported by getrusage( ).*Shown as fault* | | **squid.cachemgr.select\_loops**(gauge) | The number of times Squid called select( ) or poll( ) in the main I/O loop.*Shown as item* | | **squid.cachemgr.server.all.errors**(gauge) | The number of server-side requests (all protocols) that resulted in some kind of error.*Shown as error* | | **squid.cachemgr.server.all.kbytes\_in**(gauge) | The amount of traffic read from the server-side for all protocols.*Shown as kibibyte* | | **squid.cachemgr.server.all.kbytes\_out**(gauge) | The amount of traffic written to origin servers and/or neighbor caches for server-side requests.*Shown as kibibyte* | | **squid.cachemgr.server.all.requests**(gauge) | The number of requests forwarded to origin servers (or neighbor caches) for all server-side protocols.*Shown as request* | | **squid.cachemgr.server.ftp.errors**(gauge) | The number of requests sent to FTP servers that resulted in an error.*Shown as error* | | **squid.cachemgr.server.ftp.kbytes\_in**(gauge) | The amount of traffic read from FTP servers, including control channel traffic.*Shown as kibibyte* | | **squid.cachemgr.server.ftp.kbytes\_out**(gauge) | The amount of traffic written to FTP servers, including control channel traffic.*Shown as kibibyte* | | **squid.cachemgr.server.ftp.requests**(gauge) | The number of requests sent to FTP servers.*Shown as request* | | **squid.cachemgr.server.http.errors**(gauge) | The number of server-side HTTP requests that resulted in an error.*Shown as error* | | **squid.cachemgr.server.http.kbytes\_in**(gauge) | The amount of traffic read from HTTP origin servers and neighbor caches.*Shown as kibibyte* | | **squid.cachemgr.server.http.kbytes\_out**(gauge) | The amount of traffic written to HTTP origin servers and neighbor caches.*Shown as kibibyte* | | **squid.cachemgr.server.http.requests**(gauge) | The number of server-side requests to HTTP servers, including neighbor caches.*Shown as request* | | **squid.cachemgr.server.other.errors**(gauge) | The number of Gopher, WAIS, and SSL requests that resulted in an error.*Shown as error* | | **squid.cachemgr.server.other.kbytes\_in**(gauge) | The amount of traffic read from Gopher, WAIS, and SSL servers.*Shown as kibibyte* | | **squid.cachemgr.server.other.kbytes\_out**(gauge) | The amount of traffic written to Gopher, WAIS, and SSL servers.*Shown as kibibyte* | | **squid.cachemgr.server.other.requests**(gauge) | The number of "other" server-side requests. Currently, the other protocols are Gopher, WAIS, and SSL.*Shown as request* | | **squid.cachemgr.swap.files\_cleaned**(gauge) | The number of orphaned cache files removed by the periodic cleanup procedure.*Shown as file* | | **squid.cachemgr.swap.ins**(gauge) | The number of objects (swap files) read from disk.*Shown as file* | | **squid.cachemgr.swap.outs**(gauge) | The number of objects (swap files) saved to disk.*Shown as file* | | **squid.cachemgr.unlink.requests**(gauge) | The number of unlink requests given to the (optional) unlinkd process.*Shown as request* | ### Events{% #events %} The Squid check does not include any events. ### Service Checks{% #service-checks %} **squid.can\_connect** Returns Critical if the Agent cannot connect to the Squid URL, OK otherwise. *Statuses: ok, critical* ## Troubleshooting{% #troubleshooting %} Need help? Contact [Datadog support](https://docs.datadoghq.com/help/).