Skip to content

Commit

Permalink
Automated changes
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 17, 2023
1 parent 35c49fe commit 203a6ad
Show file tree
Hide file tree
Showing 7 changed files with 259 additions and 0 deletions.
22 changes: 22 additions & 0 deletions bindplane_otel/my_otel_config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
receivers:
hostmetrics:
collection_interval: 1m
scrapers:
load:
filesystem:
memory:
network:

processors:
batch:

exporters:
logging:
loglevel: debug

service:
pipelines:
metrics:
receivers: [hostmetrics]
processors: [batch]
exporters: [logging]
22 changes: 22 additions & 0 deletions bindplane_otel/my_otel_config1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
receivers:
hostmetrics:
collection_interval: 1m
scrapers:
load:
filesystem:
memory:
network:

processors:
batch:

exporters:
logging:
loglevel: debug

service:
pipelines:
metrics:
receivers: [hostmetrics]
processors: [batch]
exporters: [logging]
53 changes: 53 additions & 0 deletions bindplane_otel/test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# This configuration is managed by BindPlane OP.
# Configuration: test:1
receivers:
otlp/source0_01HCDADJGYVQ6CPKY6M3WHEASN:
protocols:
grpc:
endpoint: 0.0.0.0:4392
keepalive:
server_parameters:
max_connection_age: 60s
max_connection_age_grace: 300s
max_connection_idle: 60s
time: 2h
timeout: 20s
http:
endpoint: 0.0.0.0:4318
processors:
batch/nr-otlp: null
exporters:
otlp/nr-otlp:
compression: gzip
endpoint: https://otlp.nr-data.net:443
headers:
- api-key: (sensitive)
retry_on_failure:
enabled: false
sending_queue:
enabled: false
tls:
insecure: false
service:
pipelines:
logs/source0_01HCDADJGYVQ6CPKY6M3WHEASN__nr-otlp-0:
receivers:
- otlp/source0_01HCDADJGYVQ6CPKY6M3WHEASN
processors:
- batch/nr-otlp
exporters:
- otlp/nr-otlp
metrics/source0_01HCDADJGYVQ6CPKY6M3WHEASN__nr-otlp-0:
receivers:
- otlp/source0_01HCDADJGYVQ6CPKY6M3WHEASN
processors:
- batch/nr-otlp
exporters:
- otlp/nr-otlp
traces/source0_01HCDADJGYVQ6CPKY6M3WHEASN__nr-otlp-0:
receivers:
- otlp/source0_01HCDADJGYVQ6CPKY6M3WHEASN
processors:
- batch/nr-otlp
exporters:
- otlp/nr-otlp
22 changes: 22 additions & 0 deletions bindplane_otel/test1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
receivers:
hostmetrics:
collection_interval: 2m
scrapers:
load:
filesystem:
memory:
network:

processors:
batch:

exporters:
logging:
loglevel: debug

service:
pipelines:
metrics:
receivers: [hostmetrics]
processors: [batch]
exporters: [logging]
127 changes: 127 additions & 0 deletions download/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<p align="center"><img src="https://storage.googleapis.com/bindplane-op-doc-images/guides/bindplaneop.png?raw=true"></p>

<center>

[![Continuous Integration](https://github.com/observIQ/bindplane-op/actions/workflows/ci.yml/badge.svg)](https://github.com/observIQ/bindplane-op/actions/workflows/ci.yml)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Go Reference](https://pkg.go.dev/badge/github.com/observiq/bindplane-op.svg)](https://pkg.go.dev/github.com/observiq/bindplane-op)
[![Go Report Card](https://goreportcard.com/badge/github.com/observiq/bindplane-op)](https://goreportcard.com/report/github.com/observiq/bindplane-op)

</center>

# BindPlane OP

BindPlane OP is an open source observability pipeline that gives you the ability to collect, refine, and ship metrics, logs, and traces to any destination. BindPlane OP provides the controls you need to reduce observability costs and simplify the deployment and management of telemetry agents at scale.

<p align="center"><img src="https://storage.googleapis.com/bindplane-op-doc-images/guides/BindPlane_Architecture_Diagram.jpg?raw=true"></p>

## Features

- Manage the lifecycle of telemetry agents, starting with the [BindPlane Agent](https://github.com/observIQ/bindplane-agent)
- Build, deploy, and manage telemetry configurations for different Sources and deploy them to your agents
- Ship metric, log, and trace data to one or many Destinations
- Utilize flow controls to adjust the flow of your data in realtime

## Architecture

BindPlane OP is a lightweight web server (no dependencies) that you can deploy anywhere in your environment. It's composed of the following components:

- GraphQL Server: provides configuration and agent details via GraphQL
- REST Server: BindPlane CLI and UI make requests to the server via REST
- WebSocket Server: Agents connect to receive configuration updates via [OpAMP](https://github.com/open-telemetry/opamp-spec)
- Store: pluggable storage manages configuration and Agent state
- Manager: dispatches configuration changes to Agents

## Support

BindPlane OP does not have any dependencies and can run on Windows, Linux, or macOS although we recommend installing BindPlane OP server one of the following supported Linux distributions:

- Red Hat, Centos, Oracle Linux 7 and 8
- Debian 10 and 11
- Ubuntu LTS 18.04, 20.04
- Suse Linux 12 and 15
- Alma and Rocky Linux

The BindPlane CLI (included in the BindPlane OP binary) will run on Linux, Windows, and macOS. For a detailed list of commands and installation instructions for remote clients, see our [CLI](https://docs.bindplane.observiq.com/docs/cli) documentation page.

# Quick Start

The following are our recommended installation options. For more details on installation, please visit our [Getting Started](https://docs.bindplane.observiq.com/docs/getting-started) page or [Installation](https://docs.bindplane.observiq.com/docs/installation) page.

## Server

To install BindPlane Server, we recommend using our single-line installer. Alternatively, packages are available for download on our [releases](https://github.com/observIQ/bindplane-op/releases) page.

### Linux

```bash
curl -s https://storage.googleapis.com/bindplane-op-releases/bindplane/install-linux.sh | bash -s --
```

**Initialization**

After the installer finishes, initialize the server using the `init` command. The specific command for your system is found in the installer output under the `Server Initialization` section. By default it is the following command for Linux:

```bash
sudo /usr/local/bin/bindplane init server --config /etc/bindplane/config.yaml
```

## Client

See the [installation documentation](./docs/install.md#client) for client install instructions.

## Agent

BindPlane OP utilizes the [BindPlane Agent](https://github.com/observIQ/bindplane-agent). To install using BindPlane CLI, run the following command on a server or client system to generate the agent install command.

```bash
bindplane install agent
```

The generated command can then be copied and run on the agent host. To tailor the install command for a specific operating system, use the `--platform` flag. Valid values include:

- `linux`
- `linux-arm64`
- `windows`
- `macos`
- `macos-amd64`

To see additional flags and options for the agent install, use the `--help` flag.

```bash
bindplane install agent --help
```

## Configuration

The configuration of BindPlane OP is best done through the UI which can be accessed via a web browser on port 3001. The URL will be `http://<IP Address>:3001` with IP Address being the IP of the BindPlane server. To log in, use the credentials you specified when running the init command.

For more information on configuration, view our [Configuration](https://docs.bindplane.observiq.com/docs/configuration) documentation page.

# Other questions?

Join the conversation at the [BindPlane Slack](https://observiq.com/support-bindplaneop/)!

You can also check out our [documentation](https://docs.bindplane.observiq.com/), send us an [email](mailto:support.observiq.com), or open an issue with your question. We'd love to hear from you!

# Community

## Code of Conduct

BindPlane OP follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). Please report violations of the Code of Conduct to any or all maintainers.

## Development

See [development.md](/docs/development.md)

## SaaS Mode

See [saas.md](/docs/saas.md)

## Contributing

See [CONTRIBUTING.md](/docs/CONTRIBUTING.md).

<a href="https://github.com/observIQ/bindplane-op/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=observIQ/bindplane-op" />
</a>
Binary file added download/bindplane.zip
Binary file not shown.
13 changes: 13 additions & 0 deletions download/license.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# minimum confidence percentage used during license classification
threshold: .90

# all permitted licenses - if no list is specified, all licenses are assumed to be allowed
allow:
- "MIT"
- "Apache-2.0"
- "BSD-3-Clause"
- "BSD-2-Clause"
- "BSD-2-Clause-FreeBSD"
- "Zlib"
- "ISC"
- "MPL-2.0"

0 comments on commit 203a6ad

Please sign in to comment.