Skip to content

Commit

Permalink
Fix broken link and various formatting issues for the Squid Proxy int…
Browse files Browse the repository at this point in the history
…egration (#11925)

* Fix broken links and formatting issues

* Update changelog and manifest
  • Loading branch information
alaudazzi authored Nov 30, 2024
1 parent dc9fe51 commit ff5f45f
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 23 deletions.
22 changes: 11 additions & 11 deletions packages/squid/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,32 @@ Use the Squid Proxy integration to monitor Squid Proxy access logs.

This integration supports ingestion of logs from Squid Proxy, via the [Filestream](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-filestream.html), [TCP](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-tcp.html), and/or [UDP](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-udp.html) inputs.

**Log** is used to retrieve access log messages generated by Squid Proxy. See more details in the documentation [here](https://wiki.squid-cache.org/SquidFaq/SquidLogs#accesslog) and [here](https://wiki.squid-cache.org/Features/LogFormat#squid-native-accesslog-format-in-detail).
**Log** is used to retrieve access log messages generated by Squid Proxy. For more details, refer to [access.log](https://wiki.squid-cache.org/SquidFaq/SquidLogs#accesslog) and [Squid native access.log format in detail](https://wiki.squid-cache.org/Features/LogFormat#squid-native-accesslog-format-in-detail).

## Requirements

You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.

Elastic Agent must be installed. For more information, refer to the link [here](https://www.elastic.co/guide/en/fleet/current/elastic-agent-installation.html).
Elastic Agent must be installed. For more information, refer to [Install Elastic Agents](https://www.elastic.co/guide/en/fleet/current/elastic-agent-installation.html).

### Installing and managing an Elastic Agent:

You have a few options for installing and managing an Elastic Agent:

### Install a Fleet-managed Elastic Agent (recommended):
#### Install a Fleet-managed Elastic Agent (recommended):

With this approach, you install Elastic Agent and use Fleet in Kibana to define, configure, and manage your agents in a central location. We recommend using Fleet management because it makes the management and upgrade of your agents considerably easier.

### Install Elastic Agent in standalone mode (advanced users):
#### Install Elastic Agent in standalone mode (advanced users):

With this approach, you install Elastic Agent and manually configure the agent locally on the system where it’s installed. You are responsible for managing and upgrading the agents. This approach is reserved for advanced users only.

### Install Elastic Agent in a containerized environment:
#### Install Elastic Agent in a containerized environment:

You can run Elastic Agent inside a container, either with Fleet Server or standalone. Docker images for all versions of Elastic Agent are available from the Elastic Docker registry, and we provide deployment manifests for running on Kubernetes.

There are some minimum requirements for running Elastic Agent and for more information, refer to the link [here](https://www.elastic.co/guide/en/fleet/current/elastic-agent-installation.html#_minimum_requirements).
There are some minimum requirements for running Elastic Agent. For more information, refer to [Install Elastic Agents](https://www.elastic.co/guide/en/fleet/current/elastic-agent-installation.html).

The minimum **Kibana version** required is **8.14.1**.

Expand All @@ -46,12 +46,12 @@ The integration supports the following formats:

### Enabling the integration in Elastic:

1. In Kibana go to Management > Integrations.
2. In "Search for integrations" search bar, type `Squid Proxy`.
3. Click on the `Squid Proxy` integration from the search results.
4. Click on the "Add Squid Proxy" button to add the integration.
1. In Kibana go to **Management** > **Integrations**.
2. In the **Search for integrations** bar, type `Squid Proxy`.
3. Select the `Squid Proxy` integration from the search results.
4. Click **Add Squid Proxy** to add the integration.
5. Add all the required integration configuration parameters according to the enabled input type.
6. Click on "Save and continue" to save the integration.
6. Click **Save and continue**.

## Logs reference

Expand Down
5 changes: 5 additions & 0 deletions packages/squid/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.0.3"
changes:
- description: Fix broken link and various formatting issues for the Squid Proxy integration.
type: bugfix
link: https://github.com/elastic/integrations/pull/11925
- version: "1.0.2"
changes:
- description: Tolerate errors with uri_parts, ensure _tmp fields are removed in case of errors.
Expand Down
22 changes: 11 additions & 11 deletions packages/squid/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,32 @@ Use the Squid Proxy integration to monitor Squid Proxy access logs.

This integration supports ingestion of logs from Squid Proxy, via the [Filestream](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-filestream.html), [TCP](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-tcp.html), and/or [UDP](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-udp.html) inputs.

**Log** is used to retrieve access log messages generated by Squid Proxy. See more details in the documentation [here](https://wiki.squid-cache.org/SquidFaq/SquidLogs#accesslog) and [here](https://wiki.squid-cache.org/Features/LogFormat#squid-native-accesslog-format-in-detail).
**Log** is used to retrieve access log messages generated by Squid Proxy. For more details, refer to [access.log](https://wiki.squid-cache.org/SquidFaq/SquidLogs#accesslog) and [Squid native access.log format in detail](https://wiki.squid-cache.org/Features/LogFormat#squid-native-accesslog-format-in-detail).

## Requirements

You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.

Elastic Agent must be installed. For more information, refer to the link [here](https://www.elastic.co/guide/en/fleet/current/elastic-agent-installation.html).
Elastic Agent must be installed. For more information, refer to [Install Elastic Agents](https://www.elastic.co/guide/en/fleet/current/elastic-agent-installation.html).

### Installing and managing an Elastic Agent:

You have a few options for installing and managing an Elastic Agent:

### Install a Fleet-managed Elastic Agent (recommended):
#### Install a Fleet-managed Elastic Agent (recommended):

With this approach, you install Elastic Agent and use Fleet in Kibana to define, configure, and manage your agents in a central location. We recommend using Fleet management because it makes the management and upgrade of your agents considerably easier.

### Install Elastic Agent in standalone mode (advanced users):
#### Install Elastic Agent in standalone mode (advanced users):

With this approach, you install Elastic Agent and manually configure the agent locally on the system where it’s installed. You are responsible for managing and upgrading the agents. This approach is reserved for advanced users only.

### Install Elastic Agent in a containerized environment:
#### Install Elastic Agent in a containerized environment:

You can run Elastic Agent inside a container, either with Fleet Server or standalone. Docker images for all versions of Elastic Agent are available from the Elastic Docker registry, and we provide deployment manifests for running on Kubernetes.

There are some minimum requirements for running Elastic Agent and for more information, refer to the link [here](https://www.elastic.co/guide/en/fleet/current/elastic-agent-installation.html#_minimum_requirements).
There are some minimum requirements for running Elastic Agent. For more information, refer to [Install Elastic Agents](https://www.elastic.co/guide/en/fleet/current/elastic-agent-installation.html).

The minimum **Kibana version** required is **8.14.1**.

Expand All @@ -46,12 +46,12 @@ The integration supports the following formats:

### Enabling the integration in Elastic:

1. In Kibana go to Management > Integrations.
2. In "Search for integrations" search bar, type `Squid Proxy`.
3. Click on the `Squid Proxy` integration from the search results.
4. Click on the "Add Squid Proxy" button to add the integration.
1. In Kibana go to **Management** > **Integrations**.
2. In the **Search for integrations** bar, type `Squid Proxy`.
3. Select the `Squid Proxy` integration from the search results.
4. Click **Add Squid Proxy** to add the integration.
5. Add all the required integration configuration parameters according to the enabled input type.
6. Click on "Save and continue" to save the integration.
6. Click **Save and continue**.

## Logs reference

Expand Down
2 changes: 1 addition & 1 deletion packages/squid/manifest.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
format_version: 3.2.1
name: squid
title: Squid Proxy
version: "1.0.2"
version: "1.0.3"
description: Collect and parse logs from Squid devices with Elastic Agent.
categories:
- network
Expand Down

0 comments on commit ff5f45f

Please sign in to comment.