github.com/observiq/bindplane-agent@v1.51.0/README.md (about)

     1  # BindPlane Agent
     2  
     3  <center>
     4  
     5  [![Action Status](https://github.com/observIQ/bindplane-agent/workflows/Build/badge.svg)](https://github.com/observIQ/bindplane-agent/actions)
     6  [![Action Test Status](https://github.com/observIQ/bindplane-agent/workflows/Tests/badge.svg)](https://github.com/observIQ/bindplane-agent/actions)
     7  [![Go Report Card](https://goreportcard.com/badge/github.com/observIQ/bindplane-agent)](https://goreportcard.com/report/github.com/observIQ/bindplane-agent)
     8  [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
     9  
    10  </center>
    11  
    12  The BindPlane Agent is observIQ’s distribution of the [OpenTelemetry collector](https://github.com/open-telemetry/opentelemetry-collector). It’s the first distribution to implement the [Open Agent Management Protocol](https://opentelemetry.io/docs/specs/opamp/) (OpAMP) and is designed to be fully managed with [BindPlane OP](https://observiq.com/). To get started, follow our [Quickstart Guide](https://observiq.com/docs/getting-started/quickstart-guide).
    13  
    14  ## Benefits
    15  
    16  ### Focused on usability
    17  Increases the accessibility of OpenTelemetry by providing simplified installation scripts, tested example configurations, and end-to-end documentation making it easy to get started
    18  
    19  ### All the best parts of OpenTelemetry and more
    20  Bundled with all core OpenTelemetry receivers, processors, and exporters as well as additional capabilities for monitoring complex or enterprise technologies not yet available in upstream releases
    21   
    22  ### Always Production-ready and fully-supported
    23  Tested, verified, and supported by observIQ
    24  
    25  ## Quick Start
    26  
    27  ### Installation
    28  
    29  #### Linux
    30  
    31  To install using the installation script, you may run:
    32  ```sh
    33  sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh
    34  ```
    35  
    36  To install directly with the appropriate package manager, see [installing on Linux](/docs/installation-linux.md).
    37  
    38  #### Windows
    39  
    40  To install the BindPlane Agent on Windows run the Powershell command below to install the MSI with no UI.
    41  ```pwsh
    42  msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet
    43  ```
    44  
    45  Alternately, for an interactive installation [download the latest MSI](https://github.com/observIQ/bindplane-agent/releases/latest).
    46  
    47  After downloading the MSI, simply double click it to open the installation wizard. Follow the instructions to configure and install the agent.
    48  
    49  For more installation information see [installing on Windows](/docs/installation-windows.md).
    50  
    51  #### macOS
    52  
    53  To install using the installation script, you may run:
    54  
    55  ```sh
    56  sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_macos.sh)" install_macos.sh
    57  ```
    58  
    59  For more installation information see [installing on macOS](/docs/installation-mac.md).
    60  
    61  ### Next Steps
    62  
    63  Now that the agent is installed it is collecting basic metrics about the host machine printing them to the log. If you want to further configure your agent you may do so by editing the config file. To find your config file based on your OS reference the table below:
    64  
    65  | OS      | Default Location                                              |
    66  |:--------|:--------------------------------------------------------------|
    67  | Linux   | /opt/observiq-otel-collector/config.yaml                      |
    68  | Windows | C:\Program Files\observIQ OpenTelemetry Collector\config.yaml |
    69  | macOS   | /opt/observiq-otel-collector/config.yaml                      |
    70  
    71  For more information on configuration see the [Configuration section](#configuration).
    72  
    73  ## Configuration
    74  
    75  The BindPlane Agent uses OpenTelemetry configuration.
    76  
    77  For sample configs, see the [config](/config/) directory.
    78  For general configuration help, see the [OpenTelemetry docs](https://opentelemetry.io/docs/collector/configuration/).
    79  
    80  For configuration options of a specific component, take a look at the README found in their respective module roots. For a list of currently supported components see [Included Components](#included-components).
    81  
    82  For a list of possible command line arguments to use with the agent, run the agent with the `--help` argument.
    83  
    84  ### Included Components
    85  
    86  #### Receivers
    87  
    88  For supported receivers and their documentation see [receivers](/docs/receivers.md).
    89  
    90  #### Processors
    91  
    92  For supported processors and their documentation see [processors](/docs/processors.md).
    93  
    94  #### Exporters
    95  
    96  For supported exporters and their documentation see [exporters](/docs/exporters.md).
    97  
    98  #### Extensions
    99  
   100  For supported extensions and their documentation see [extensions](/docs/extensions.md).
   101  
   102  #### Connectors
   103  
   104  For supported connectors and their documentation see [connectors](/docs/connectors.md).
   105  
   106  ## Example
   107  
   108  Here is an example `config.yaml` setup for hostmetrics on Google Cloud. To make sure your environment is set up with required prerequisites, see our [Google Cloud Exporter Prerequisites](/config/google_cloud_exporter/README.md) page. Further details for this GCP example can be found [here](/config/google_cloud_exporter/hostmetrics).
   109  
   110  ```yaml
   111  # Receivers collect metrics from a source. The hostmetrics receiver will get
   112  # CPU load metrics about the machine the agent is running on every minute.
   113  receivers:
   114    hostmetrics:
   115      collection_interval: 60s
   116      scrapers:
   117        cpu:
   118        disk:
   119        load:
   120        filesystem:
   121        memory:
   122        network:
   123        paging:
   124        processes:
   125  
   126  # Exporters send the data to a destination, in this case GCP.
   127  exporters: 
   128    googlecloud:
   129  
   130  # Service specifies how to construct the data pipelines using the configurations above.
   131  service:
   132    pipelines:
   133      metrics:
   134        receivers: [hostmetrics]
   135        exporters: [googlecloud]
   136  ```
   137  
   138  # Community
   139  
   140  The BindPlane Agent is an open source project. If you'd like to contribute, take a look at our [contribution guidelines](/CONTRIBUTING.md) and [developer guide](/docs/development.md). We look forward to building with you.
   141  
   142  # How can we help?
   143  
   144  If you need any additional help feel free to file a GitHub issue or reach out to us at support@observiq.com.