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.
Supported metrics
| OpsRamp Metric | Metric Display Name | Unit |
|---|---|---|
| squid_cachemgr_client_http_requests Number of HTTP requests received from clients | Client Http Requests | Requests / second |
| squid_cachemgr_client_http_hits Number of cache hits in response to client requests | Client Http Hits | Hits / second |
| squid_cachemgr_client_http_errors Number of client transactions that resulted in an error | Client Http Errors | Errors / second |
| squid_cachemgr_client_http_kbytes_in Amount of traffic received from clients in their requests | Client Http Kbytes In | Kibibytes / second |
| squid_cachemgr_client_http_kbytes_out Amount of traffic sent to clients in responses | Client Http Kbytes Out | kibibytes / second |
| squid_cachemgr_client_http_hit_kbytes_out Amount of traffic sent to clients in responses that are cache hits | Client Http Hit Kbytes Out | kibibytes / second |
| squid_cachemgr_server_all_requests Number of requests forwarded to origin servers (or neighbor caches) for all server-side protocols | Server All Requests | Requests / second |
| squid_cachemgr_server_all_errors Number of server-side requests (all protocols) that resulted in some kind of error | Server All Errors | Errors / second |
| squid_cachemgr_server_all_kbytes_in Amount of traffic read from the server-side for all protocols | Server All Kbytes In | kibibytes / second |
| squid_cachemgr_server_all_kbytes_out Amount of traffic written to origin servers and/or neighbor caches for server-side requests | Server All Kbytes Out | kibibytes / second |
| squid_cachemgr_server_http_requests Number of server-side requests to HTTP servers, including neighbor caches | Server Http Requests | Requests / second |
| squid_cachemgr_server_http_errors Number of server-side HTTP requests that resulted in an error | Server Http Errors | Errors / second |
| squid_cachemgr_server_http_kbytes_in Amount of traffic read from HTTP origin servers and neighbor caches | Server Http Kbytes In | kibibytes / second |
| squid_cachemgr_server_http_kbytes_out Amount of traffic written to HTTP origin servers and neighbor caches | Server Http Kbytes Out | kibibytes / second |
| squid_cachemgr_server_ftp_requests Number of requests sent to FTP servers | Server Ftp Requests | Requests / second |
| squid_cachemgr_server_ftp_errors Number of requests sent to FTP servers that resulted in an error | Server Ftp Errors | Errors / second |
| squid_cachemgr_server_ftp_kbytes_in Amount of traffic read from FTP servers, including control channel traffic | Server Ftp Kbytes In | kibibytes / second |
| squid_cachemgr_server_ftp_kbytes_out Amount of traffic written to FTP servers, including control channel traffic | Server Ftp Kbytes Out | kibibytes / second |
| squid_cachemgr_server_other_requests Number of "other" server-side requests. Currently, the other protocols are Gopher, WAIS, and SSL | Server Other Requests | Requests / second |
| squid_cachemgr_server_other_errors Number of Gopher, WAIS, and SSL requests that resulted in an error | Server Other Errors | Errors / second |
| squid_cachemgr_server_other_kbytes_in Amount of traffic read from Gopher, WAIS, and SSL servers | Server Other Kbytes In | kibibytes / second |
| squid_cachemgr_server_other_kbytes_out Amount of traffic written to Gopher, WAIS, and SSL servers | Server Other Kbytes Out | kibibytes / second |
| squid_cachemgr_icp_pkts_sent Number of ICP messages sent to neighbors. This includes both queries and replies but does not include HTCP messages | Icp Pkts Sent | Messages / second |
| squid_cachemgr_icp_pkts_recv Number of ICP messages received from neighbors, including both queries and replies | Icp Pkts Recv | Messages / second |
| squid_cachemgr_icp_queries_sent Number of ICP queries sent to neighbors | Icp Queries Sent | Queries / second |
| squid_cachemgr_icp_replies_sent Number of ICP replies sent to neighbors | Icp Replies Sent | Response / second |
| squid_cachemgr_icp_queries_recv Number of ICP queries received from neighbors | Icp Queries Recv | Queries / second |
| squid_cachemgr_icp_replies_recv Number of ICP replies received from neighbors | Icp Replies Recv | Response / second |
| squid_cachemgr_icp_query_timeouts Number of times that Squid timed out waiting for ICP replies to arrive | Icp Query Timeouts | Errors / second |
| squid_cachemgr_icp_replies_queued Number of times Squid queued an ICP message after the initial attempt to send failed | Icp Replies Queued | Messages / second |
| squid_cachemgr_icp_kbytes_sent Amount of traffic sent in all ICP messages, including both queries and replies | Icp Kbytes Sent | kibibytes / second |
| squid_cachemgr_icp_kbytes_recv Amount of traffic received in all ICP messages, including both queries and replies | Icp Kbytes Recv | kibibytes / second |
| squid_cachemgr_icp_q_kbytes_sent Amount of traffic sent to neighbors in ICP queries | Icp Q Kbytes Sent | kibibytes / second |
| squid_cachemgr_icp_r_kbytes_sent Amount of traffic sent to neighbors in ICP replies | Icp R Kbytes Sent | kibibytes / second |
| squid_cachemgr_icp_q_kbytes_recv Amount of traffic received from neighbors in ICP queries | Icp Q Kbytes Recv | kibibytes / second |
| squid_cachemgr_icp_r_kbytes_recv Amount of traffic received from neighbors in ICP replies | Icp R Kbytes Recv | kibibytes / second |
| squid_cachemgr_icp_times_used Number of times ICP resulted in the selection of a neighbor as the next-hop for a cache miss | Icp Times Used | per second |
| squid_cachemgr_cd_times_used Number of times Cache Digests resulted in the selection of a neighbor as the next-hop for a cache miss | Cd Times Used | per second |
| squid_cachemgr_cd_msgs_sent Number of Cache Digest messages sent to neighbors | Cd Msgs Sent | Messages / second |
| squid_cachemgr_cd_msgs_recv Number of Cache Digest messages received from neighbors | Cd Msgs Recv | Messages / second |
| squid_cachemgr_cd_memory Amount of memory used by enabling the Cache Digests' feature | Cd Memory | kibibytes / second |
| squid_cachemgr_cd_local_memory Amount of memory used to store Squid own Cache Digest | Cd Local Memory | kibibytes / second |
| squid_cachemgr_cd_kbytes_sent Amount of traffic sent to neighbors in Cache Digest messages | Cd Kbytes Sent | kibibytes / second |
| squid_cachemgr_cd_kbytes_recv Amount of traffic received from neighbors in Cache Digest messages | Cd Kbytes Recv | kibibytes / second |
| squid_cachemgr_unlink_requests Number of unlink requests given to the (optional) unlinkd process | Unlink Requests | Requests / second |
| squid_cachemgr_page_faults Number of (major) page faults as reported by getrusage( ) | Page Faults | Faults / second |
| squid_cachemgr_select_loops Number of times Squid called select( ) or poll( ) in the main I/O loop | Select Loops | Items / second |
| squid_cachemgr_cpu_time Amount of CPU used by squid, as reported by getrusage( ) | Cpu Time | percent |
| squid_cachemgr_swap_outs Number of objects (swap files) saved to disk | Swap Outs | Files / second |
| squid_cachemgr_swap_ins Number of objects (swap files) read from disk | Swap Ins | Files / second |
| squid_cachemgr_swap_files_cleaned Number of orphaned cache files removed by the periodic cleanup procedure | Swap Files Cleaned | Files / second |
| squid_cachemgr_aborted_requests Number of server-side HTTP requests aborted due to client-side aborts | Aborted Requests | Requests / second |
| squid_cachemgr_icp_messages_received Total number of ICP messages received since Squid was started. | Icp Messages Received | Messages / seconds |
| squid_cachemgr_icp_messages_sent Total number of ICP messages sent since Squid was started. | Icp Messages Sent | Messages / seconds |
| squid_fqdn_cache_entries Number of FQDN cache entries | Fqdn Cache Entries | Entries |
| squid_clients Number of clients accessing cache, client actually means IP address. Squid assumes that each client has a unique IP address | Clients | Clients |
| squid_requests_disk_hit_ratio These values represent the percentage of plain cache hits served from disk | Requests Disk Hit Ratio | percent |
| squid_cache_hit_ratio Percentage of HTTP requests that result in a cache hit | Cache Hit Ratio | percent |
| squid_request_failure_ratio Average ratio between the number of failed and successful requests | Request Failure Ratio | percent |
| squid_cache_byte_hit_ratio 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 | Cache Byte Hit Ratio | percent |
| squid_ip_cache_entries Number of IP cache entries | Ip Cache Entries | Entries |
| squid_request_memory_hit_ratio These values represent the percentage of all cache hits that were served from memory | Request Memory Hit Ratio | percent |
| squid_ip_cache_statistics The IP cache contains cached results of hostname-to-address lookups | Ip Cache Statistics | per second |
| squid_fqdn_cache_statistics The FQDN cache is similar to the IP cache, except that it stores address-to-hostname lookups | Fqdn Cache Statistics | per second |
| squid_service_times Median of various service time (or response time) distributions | Service Times | seconds |