-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Syslog receiver **Link to tracking Issue:** #2331 **Testing:** Unit tests are included **Documentation:** Syslog receiver README.md is included
- Loading branch information
Showing
14 changed files
with
1,879 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| include ../../Makefile.Common |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| # Syslog Receiver | ||
|
|
||
| Parses Syslogs from tcp/udp using | ||
| the [opentelemetry-log-collection](https://github.com/open-telemetry/opentelemetry-log-collection) library. | ||
|
|
||
| Supported pipeline types: logs | ||
|
|
||
| > :construction: This receiver is in alpha and configuration fields are subject to change. | ||
| ## Configuration | ||
|
|
||
| | Field | Default | Description | | ||
| | ---------- | ---------------- | ------------------------------------------------------------ | | ||
| | `id` | `syslog_input` | A unique identifier for the operator | | ||
| | `udp` |`nil` | Defined udp_input operator. (see the UDP configuration section) | | ||
| | `tcp` | `nil` | Defined tcp_input operator. (see the TCP configuration section) | | ||
| | `protocol` | required | The protocol to parse the syslog messages as. Options are `rfc3164` and `rfc5424` | | ||
| | `location` | `UTC` | The geographic location (timezone) to use when parsing the timestamp (Syslog RFC 3164 only). The available locations depend on the local IANA Time Zone database. [This page](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) contains many examples, such as `America/New_York`. | | ||
| | `timestamp` | `nil` | An optional [timestamp](https://github.com/open-telemetry/opentelemetry-log-collection/blob/main/docs/types/timestamp.md) block which will parse a timestamp field before passing the entry to the output operator | | ||
| | `severity` | `nil` | An optional [severity](https://github.com/open-telemetry/opentelemetry-log-collection/blob/main/docs/docs/types/severity.md) block which will parse a severity field before passing the entry to the output operator | ||
| | `attributes` | {} | A map of `key: value` labels to add to the entry's attributes | | ||
| | `resource` | {} | A map of `key: value` labels to add to the entry's resource | | ||
|
|
||
| ### UDP Configuration | ||
|
|
||
| | Field | Default | Description | | ||
| | --- | --- | --- | | ||
| | `listen_address` | required | A listen address of the form `<ip>:<port>` | | ||
|
|
||
| ### TCP Configuration | ||
|
|
||
| | Field | Default | Description | | ||
| | --- | --- | --- | | ||
| | `max_buffer_size` | `1024kib` | Maximum size of buffer that may be allocated while reading TCP input | | ||
| | `listen_address` | required | A listen address of the form `<ip>:<port>` | | ||
| | `tls` | | An optional `TLS` configuration (see the TLS configuration section) | | ||
|
|
||
| #### TLS Configuration | ||
|
|
||
| The `tcp_input` operator supports TLS, disabled by default. | ||
|
|
||
| | Field | Default | Description | | ||
| | --- | --- | --- | | ||
| | `cert_file` | | Path to the TLS cert to use for TLS required connections. | | ||
| | `key_file` | | Path to the TLS key to use for TLS required connections.| | ||
| | `ca_file` | | Path to the CA cert. For a client this verifies the server certificate. For a server this verifies client certificates. If empty uses system root CA. | | ||
| | `client_ca_file` | | (optional) Path to the TLS cert to use by the server to verify a client certificate. This sets the ClientCAs and ClientAuth to RequireAndVerifyClientCert in the TLSConfig. Please refer to godoc.org/crypto/tls#Config for more information. | ||
| | | ||
|
|
||
| ## Example Configurations | ||
|
|
||
| TCP Configuration: | ||
|
|
||
| ```yaml | ||
| - type: syslog_input | ||
| protocol: rfc5424 | ||
| tcp: | ||
| listen_address: "0.0.0.0:54526" | ||
| ``` | ||
| UDP Configuration: | ||
| ```yaml | ||
| - type: syslog_input | ||
| udp: | ||
| listen_address: "0.0.0.0:54526" | ||
| protocol: rfc3164 | ||
| location: UTC | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| // Copyright 2021 OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package syslogreceiver |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| module github.com/open-telemetry/opentelemetry-collector-contrib/receiver/syslogreceiver | ||
|
|
||
| go 1.14 | ||
|
|
||
| require ( | ||
| github.com/open-telemetry/opentelemetry-collector-contrib/internal/stanza v0.0.0-00010101000000-000000000000 | ||
| github.com/open-telemetry/opentelemetry-log-collection v0.16.1-0.20210315170618-aa8d82509c31 | ||
| github.com/stretchr/testify v1.7.0 | ||
| go.opentelemetry.io/collector v0.22.1-0.20210313012550-03904de3dd61 | ||
| go.uber.org/zap v1.16.0 | ||
| gopkg.in/yaml.v2 v2.4.0 | ||
| ) | ||
|
|
||
| replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/stanza => ../../internal/stanza |
Oops, something went wrong.