Squid is a caching proxy for the Web supporting HTTP, HTTPS, FTP, and more. It reduces bandwidth and improves response times by caching and reusing frequently-requested web pages. Squid has extensive access controls and makes a great server accelerator. It runs on most available operating systems, including Windows and is licensed under the GNU GPL.
Prerequisite
For Virtual Machines, install the Linux Agent.
Configuring the credentials
Configure the credentials in the directory /opt/opsramp/agent/conf/app.d/creds.yaml
squid:
- name: squid
user: <username>
pwd: <Password>
encoding-type: plain
labels:
key1: val1
key2: val2
Configuring the application
Virtual Machine
Configure the application in the directory /opt/opsramp/agent/conf/app/discovery/auto-detection.yaml
- name: squid
instance-checks:
service-check:
- squid
process-check:
- squid
port-check:
- 3128
Docker environment
Configure the application in the directory /opt/opsramp/agent/conf/app/discovery/auto-container-detection.yaml
- name: squid
container-checks:
image-check:
- squid
port-check:
- 3128
Kubernetes environment
Configure the application in config.yaml
- name: squid
container-checks:
image-check:
- squid
port-check:
- 3128
Validate
Go to Resources under the Infrastructure tab to check if your resources are onboarded and the metrics are collected.
Metrics
| OpsRamp Metric | Metric Display Name | Unit | Description |
|---|---|---|---|
| squid_cachemgr_client_http_requests | Client Http Requests | Requests / second | Number of HTTP requests received from clients |
| squid_cachemgr_client_http_hits | Client Http Hits | Hits / second | Number of cache hits in response to client requests |
| squid_cachemgr_client_http_errors | Client Http Errors | Errors / second | Number of client transactions that resulted in an error |
| squid_cachemgr_client_http_kbytes_in | Client Http Kbytes In | Kibibytes / second | Amount of traffic received from clients in their requests |
| squid_cachemgr_client_http_kbytes_out | Client Http Kbytes Out | kibibytes / second | Amount of traffic sent to clients in responses |
| squid_cachemgr_client_http_hit_kbytes_out | Client Http Hit Kbytes Out | kibibytes / second | Amount of traffic sent to clients in responses that are cache hits |
| squid_cachemgr_server_all_requests | Server All Requests | Requests / second | Number of requests forwarded to origin servers (or neighbor caches) for all server-side protocols |
| squid_cachemgr_server_all_errors | Server All Errors | Errors / second | Number of server-side requests (all protocols) that resulted in some kind of error |
| squid_cachemgr_server_all_kbytes_in | Server All Kbytes In | kibibytes / second | Amount of traffic read from the server-side for all protocols |
| squid_cachemgr_server_all_kbytes_out | Server All Kbytes Out | kibibytes / second | Amount of traffic written to origin servers and/or neighbor caches for server-side requests |
| squid_cachemgr_server_http_requests | Server Http Requests | Requests / second | Number of server-side requests to HTTP servers, including neighbor caches |
| squid_cachemgr_server_http_errors | Server Http Errors | Errors / second | Number of server-side HTTP requests that resulted in an error |
| squid_cachemgr_server_http_kbytes_in | Server Http Kbytes In | kibibytes / second | Amount of traffic read from HTTP origin servers and neighbor caches |
| squid_cachemgr_server_http_kbytes_out | Server Http Kbytes Out | kibibytes / second | Amount of traffic written to HTTP origin servers and neighbor caches |
| squid_cachemgr_server_ftp_requests | Server Ftp Requests | Requests / second | Number of requests sent to FTP servers |
| squid_cachemgr_server_ftp_errors | Server Ftp Errors | Errors / second | Number of requests sent to FTP servers that resulted in an error |
| squid_cachemgr_server_ftp_kbytes_in | Server Ftp Kbytes In | kibibytes / second | Amount of traffic read from FTP servers, including control channel traffic |
| squid_cachemgr_server_ftp_kbytes_out | Server Ftp Kbytes Out | kibibytes / second | Amount of traffic written to FTP servers, including control channel traffic |
| squid_cachemgr_server_other_requests | Server Other Requests | Requests / second | Number of "other" server-side requests. Currently, the other protocols are Gopher, WAIS, and SSL |
| squid_cachemgr_server_other_errors | Server Other Errors | Errors / second | Number of Gopher, WAIS, and SSL requests that resulted in an error |
| squid_cachemgr_server_other_kbytes_in | Server Other Kbytes In | kibibytes / second | Amount of traffic read from Gopher, WAIS, and SSL servers |
| squid_cachemgr_server_other_kbytes_out | Server Other Kbytes Out | kibibytes / second | Amount of traffic written to Gopher, WAIS, and SSL servers |
| squid_cachemgr_icp_pkts_sent | Icp Pkts Sent | Messages / second | Number of ICP messages sent to neighbors. This includes both queries and replies but doesn't include HTCP messages |
| squid_cachemgr_icp_pkts_recv | Icp Pkts Recv | Messages / second | Number of ICP messages received from neighbors, including both queries and replies |
| squid_cachemgr_icp_queries_sent | Icp Queries Sent | Queries / second | Number of ICP queries sent to neighbors |
| squid_cachemgr_icp_replies_sent | Icp Replies Sent | Response / second | Number of ICP replies sent to neighbors |
| squid_cachemgr_icp_queries_recv | Icp Queries Recv | Queries / second | Number of ICP queries received from neighbors |
| squid_cachemgr_icp_replies_recv | Icp Replies Recv | Response / second | Number of ICP replies received from neighbors |
| squid_cachemgr_icp_query_timeouts | Icp Query Timeouts | Errors / second | Number of times that Squid timed out waiting for ICP replies to arrive |
| squid_cachemgr_icp_replies_queued | Icp Replies Queued | Messages / second | Number of times Squid queued an ICP message after the initial attempt to send failed |
| squid_cachemgr_icp_kbytes_sent | Icp Kbytes Sent | kibibytes / second | Amount of traffic sent in all ICP messages, including both queries and replies |
| squid_cachemgr_icp_kbytes_recv | Icp Kbytes Recv | kibibytes / second | Amount of traffic received in all ICP messages, including both queries and replies |
| squid_cachemgr_icp_q_kbytes_sent | Icp Q Kbytes Sent | kibibytes / second | Amount of traffic sent to neighbors in ICP queries |
| squid_cachemgr_icp_r_kbytes_sent | Icp R Kbytes Sent | kibibytes / second | Amount of traffic sent to neighbors in ICP replies |
| squid_cachemgr_icp_q_kbytes_recv | Icp Q Kbytes Recv | kibibytes / second | Amount of traffic received from neighbors in ICP queries |
| squid_cachemgr_icp_r_kbytes_recv | Icp R Kbytes Recv | kibibytes / second | Amount of traffic received from neighbors in ICP replies |
| squid_cachemgr_icp_times_used | Icp Times Used | per second | Number of times ICP resulted in the selection of a neighbor as the next-hop for a cache miss |
| squid_cachemgr_cd_times_used | Cd Times Used | per second | Number of times Cache Digests resulted in the selection of a neighbor as the next-hop for a cache miss |
| squid_cachemgr_cd_msgs_sent | Cd Msgs Sent | Messages / second | Number of Cache Digest messages sent to neighbors |
| squid_cachemgr_cd_msgs_recv | Cd Msgs Recv | Messages / second | Number of Cache Digest messages received from neighbors |
| squid_cachemgr_cd_memory | Cd Memory | kibibytes / second | Amount of memory used by enabling the Cache Digests' feature |
| squid_cachemgr_cd_local_memory | Cd Local Memory | kibibytes / second | Amount of memory used to store Squid's own Cache Digest |
| squid_cachemgr_cd_kbytes_sent | Cd Kbytes Sent | kibibytes / second | Amount of traffic sent to neighbors in Cache Digest messages |
| squid_cachemgr_cd_kbytes_recv | Cd Kbytes Recv | kibibytes / second | Amount of traffic received from neighbors in Cache Digest messages |
| squid_cachemgr_unlink_requests | Unlink Requests | Requests / second | Number of unlink requests given to the (optional) unlinkd process |
| squid_cachemgr_page_faults | Page Faults | Faults / second | Number of (major) page faults as reported by getrusage( ) |
| squid_cachemgr_select_loops | Select Loops | Items / second | Number of times Squid called select( ) or poll( ) in the main I/O loop |
| squid_cachemgr_cpu_time | Cpu Time | percent | Amount of CPU used by squid, as reported by getrusage( ) |
| squid_cachemgr_swap_outs | Swap Outs | Files / second | Number of objects (swap files) saved to disk |
| squid_cachemgr_swap_ins | Swap Ins | Files / second | Number of objects (swap files) read from disk |
| squid_cachemgr_swap_files_cleaned | Swap Files Cleaned | Files / second | Number of orphaned cache files removed by the periodic cleanup procedure |
| squid_cachemgr_aborted_requests | Aborted Requests | Requests / second | Number of server-side HTTP requests aborted due to client-side aborts |
| squid_cachemgr_icp_messages_received | Icp Messages Received | Messages / seconds | Total number of ICP messages received since Squid was started. |
| squid_cachemgr_icp_messages_sent | Icp Messages Sent | Messages / seconds | Total number of ICP messages sent since Squid was started. |
| squid_fqdn_cache_entries | Fqdn Cache Entries | Entries | Number of FQDN cache entries |
| squid_clients | Clients | Clients | Number of clients accessing cache, client actually means IP address. Squid assumes that each client has a unique IP address |
| squid_requests_disk_hit_ratio | Requests Disk Hit Ratio | percent | These values represent the percentage of plain cache hits served from disk |
| squid_cache_hit_ratio | Cache Hit Ratio | percent | Percentage of HTTP requests that result in a cache hit |
| squid_request_failure_ratio | Request Failure Ratio | percent | Average ratio between the number of failed and successful requests |
| squid_cache_byte_hit_ratio | Cache Byte Hit Ratio | percent | Squid calculates byte hit ratio by comparing the number of bytes received from origin servers (or neighbors) to the number of bytes sent to clients |
| squid_ip_cache_entries | Ip Cache Entries | Entries | Number of IP cache entries |
| squid_request_memory_hit_ratio | Request Memory Hit Ratio | percent | These values represent the percentage of all cache hits that were served from memory |
| squid_ip_cache_statistics | Ip Cache Statistics | per second | The IP cache contains cached results of hostname-to-address lookups |
| squid_fqdn_cache_statistics | Fqdn Cache Statistics | per second | The FQDN cache is similar to the IP cache, except that it stores address-to-hostname lookups |
| squid_service_times | Service Times | seconds | Median of various service time (or response time) distributions |