github.com/observiq/carbon@v0.9.11-0.20200820160507-1b872e368a5e/docs/README.md (about)

     1  # Carbon Log Agent Documentation
     2  
     3  This repo contains documentation for the Carbon Log Agent.
     4  
     5  ## How do I configure the agent?
     6  The agent is configured using a YAML config file that is passed in using the `--config` flag. This file defines a collection of operators beneath a top-level `pipeline` key. Each operator possesses a `type` and `id` field.
     7  
     8  ```yaml
     9  plugins:
    10    - type: udp_input
    11      listen_address: :5141
    12  
    13    - type: syslog_parser
    14      parse_from: message
    15      protocol: rfc5424
    16  
    17    - type: elastic_output
    18  ```
    19  
    20  ## What is an operator?
    21  An operator is the most basic unit of log processing. Each operator fulfills only a single responsibility, such as reading lines from a file, or parsing JSON from a field. These operators are then chained together in a pipeline to achieve a desired result.
    22  
    23  For instance, a user may read lines from a file using the `file_input` operator. From there, the results of this operation may be sent to a `regex_parser` operator that creates fields based on a regex pattern. And then finally, these results may be sent to a `elastic_output` operator that writes each line to Elasticsearch.
    24  
    25  ## What operators are available?
    26  
    27  Inputs:
    28  - [File input](/docs/operators/file_input.md)
    29  - [Windows Event Log input](/docs/operators/windows_eventlog_input.md)
    30  - [TCP input](/docs/operators/tcp_input.md)
    31  - [UDP input](/docs/operators/udp_input.md)
    32  - [Journald input](/docs/operators/journald_input.md)
    33  - [Generate input](/docs/operators/generate_input.md)
    34  
    35  Parsers:
    36  - [JSON parser](/docs/operators/json_parser.md)
    37  - [Regex parser](/docs/operators/regex_parser.md)
    38  - [Syslog parser](/docs/operators/syslog_parser.md)
    39  - [Severity parser](/docs/operators/severity_parser.md)
    40  - [Time parser](/docs/operators/time_parser.md)
    41  
    42  Outputs:
    43  - [Google Cloud Logging](/docs/operators/google_cloud_output.md)
    44  - [Elasticsearch](/docs/operators/elastic_output.md)
    45  - [Stdout](/docs/operators/stdout.md)
    46  
    47  General purpose:
    48  - [Metadata](/docs/operators/metadata.md)
    49  - [Restructure records](/docs/operators/restructure.md)
    50  - [Router](/docs/operators/router.md)
    51  - [Kubernetes Metadata Decorator](/docs/operators/k8s_metadata_decorator.md)
    52  - [Host Metadata](/docs/operators/host_metadata.md)
    53  - [Rate limit](/docs/operators/rate_limit.md)
    54  
    55  Or create your own [plugins](/docs/plugins.md) for a technology-specific use case.