Squid log files
Squid log files
Plugin: go.d.plugin Module: squidlog
Overview
his collector monitors Squid servers by parsing their access log files.
It automatically detects log files of Squid severs running on localhost.
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
Default Behavior
Auto-Detection
This integration doesn’t support auto-detection.
Limits
The default configuration for this integration does not impose any limits on data collection.
Performance Impact
The default configuration for this integration is not expected to impose a significant performance impact on the system.
Setup
You can configure the squidlog collector in two ways:
| Method | Best for | How to |
|---|---|---|
| UI | Fast setup without editing files | Go to Nodes → Configure this node → Collectors → Jobs, search for squidlog, then click + to add a job. |
| File | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit go.d/squidlog.conf and add a job. |
:::important
UI configuration requires paid Netdata Cloud plan.
:::
Prerequisites
No action required.
Configuration
Options
Squid log format codes.
Squidlog is aware how to parse and interpret the following codes:
| field | squid format code | description |
|---|---|---|
| resp_time | %tr | Response time (milliseconds). |
| client_address | %>a | Client source IP address. |
| client_address | %>A | Client FQDN. |
| cache_code | %Ss | Squid request status (TCP_MISS etc). |
| http_code | %>Hs | The HTTP response status code from Content Gateway to client. |
| resp_size | %<st | Total size of reply sent to client (after adaptation). |
| req_method | %rm | Request method (GET/POST etc). |
| hier_code | %Sh | Squid hierarchy status (DEFAULT_PARENT etc). |
| server_address | %<a | Server IP address of the last server or peer connection. |
| server_address | %<A | Server FQDN or peer name. |
| mime_type | %mt | MIME content type. |
In addition, to make Squid native log format csv parsable, squidlog understands these groups of codes:
| field | squid format code | description |
|---|---|---|
| result_code | %Ss/%>Hs | Cache code and http code. |
| hierarchy | %Sh/%<a | Hierarchy code and server address. |
| Group | Option | Description | Default | Required |
|---|---|---|---|---|
| Collection | update_every | Data collection frequency (seconds). | 1 | no |
| autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no | |
| Target | path | Path to the Squid access log file. | /var/log/squid/access.log | yes |
| exclude_path | File path patterns to exclude. | *.gz | no | |
| Parser | parser | Log parser configuration block. | no | |
| parser.log_type | Log parser type (csv, ltsv, regexp, or auto). |
auto | no | |
| parser.csv_config | CSV log parser configuration block. | no | ||
| parser.csv_config.delimiter | CSV field delimiter. | space | no | |
| parser.csv_config.format | CSV log format string. | - $resp_time $client_address $result_code $resp_size $req_method - - $hierarchy $mime_type | yes | |
| parser.ltsv_config | LTSV log parser configuration block. | no | ||
| parser.ltsv_config.field_delimiter | LTSV field delimiter. | \t | no | |
| parser.ltsv_config.value_delimiter | LTSV value delimiter. | : | no | |
| parser.ltsv_config.mapping | LTSV fields mapping to known fields. | yes | ||
| parser.regexp_config | RegExp log parser configuration block. | no | ||
| parser.regexp_config.pattern | RegExp pattern with named groups mapped to known fields. | yes |
via UI
Configure the squidlog collector from the Netdata web interface:
- Go to Nodes.
- Select the node where you want the squidlog data-collection job to run and click the :gear: (Configure this node). That node will run the data collection.
- The Collectors → Jobs view opens by default.
- In the Search box, type squidlog (or scroll the list) to locate the squidlog collector.
- Click the + next to the squidlog collector to add a new job.
- Fill in the job fields, then click Test to verify the configuration and Submit to save.
- Test runs the job with the provided settings and shows whether data can be collected.
- If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
via File
The configuration file name for this integration is go.d/squidlog.conf.
The file format is YAML. Generally, the structure is:
update_every: 1
autodetection_retry: 0
jobs:
- name: some_name1
- name: some_name2
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/squidlog.conf
Examples
There are no configuration examples.
Metrics
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
Per Squid log files instance
These metrics refer to the entire monitored application.
This scope has no labels.
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| squidlog.requests | requests | requests/s |
| squidlog.excluded_requests | unmatched | requests/s |
| squidlog.type_requests | success, bad, redirect, error | requests/s |
| squidlog.http_status_code_class_responses | 1xx, 2xx, 3xx, 4xx, 5xx | responses/s |
| squidlog.http_status_code_responses | a dimension per HTTP response code | responses/s |
| squidlog.bandwidth | sent | kilobits/s |
| squidlog.response_time | min, max, avg | milliseconds |
| squidlog.uniq_clients | clients | clients |
| squidlog.cache_result_code_requests | a dimension per cache result code | requests/s |
| squidlog.cache_result_code_transport_tag_requests | a dimension per cache result delivery transport tag | requests/s |
| squidlog.cache_result_code_handling_tag_requests | a dimension per cache result handling tag | requests/s |
| squidlog.cache_code_object_tag_requests | a dimension per cache result produced object tag | requests/s |
| squidlog.cache_code_load_source_tag_requests | a dimension per cache result load source tag | requests/s |
| squidlog.cache_code_error_tag_requests | a dimension per cache result error tag | requests/s |
| squidlog.http_method_requests | a dimension per HTTP method | requests/s |
| squidlog.mime_type_requests | a dimension per MIME type | requests/s |
| squidlog.hier_code_requests | a dimension per hierarchy code | requests/s |
| squidlog.server_address_forwarded_requests | a dimension per server address | requests/s |
Alerts
There are no alerts configured by default for this integration.
Troubleshooting
Debug Mode
Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
To troubleshoot issues with the squidlog collector, run the go.d.plugin with the debug option enabled. The output
should give you clues as to why the collector isn’t working.
-
Navigate to the
plugins.ddirectory, usually at/usr/libexec/netdata/plugins.d/. If that’s not the case on your system, opennetdata.confand look for thepluginssetting under[directories].cd /usr/libexec/netdata/plugins.d/ -
Switch to the
netdatauser.sudo -u netdata -s -
Run the
go.d.pluginto debug the collector:./go.d.plugin -d -m squidlogTo debug a specific job:
./go.d.plugin -d -m squidlog -j jobName
Getting Logs
If you’re encountering problems with the squidlog collector, follow these steps to retrieve logs and identify potential issues:
- Run the command specific to your system (systemd, non-systemd, or Docker container).
- Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
System with systemd
Use the following command to view logs generated since the last Netdata service restart:
journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep squidlog
System without systemd
Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector’s name:
grep squidlog /var/log/netdata/collector.log
Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.
Docker Container
If your Netdata runs in a Docker container named “netdata” (replace if different), use this command:
docker logs netdata 2>&1 | grep squidlog