Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Rename to bindplane-otel-collector #2043

Merged
merged 3 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 6 additions & 6 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ builds:
goarch: ppc64le
ldflags:
- -s -w
- -X github.com/observiq/bindplane-agent/internal/version.version=v{{ .Version }}
- -X github.com/observiq/bindplane-agent/internal/version.gitHash={{ .FullCommit }}
- -X github.com/observiq/bindplane-agent/internal/version.date={{ .Date }}
- -X github.com/observiq/bindplane-otel-collector/internal/version.version=v{{ .Version }}
- -X github.com/observiq/bindplane-otel-collector/internal/version.gitHash={{ .FullCommit }}
- -X github.com/observiq/bindplane-otel-collector/internal/version.date={{ .Date }}
no_unique_dist_dir: false
- id: updater
binary: updater
Expand Down Expand Up @@ -77,9 +77,9 @@ builds:
goarch: ppc64le
ldflags:
- -s -w
- -X github.com/observiq/bindplane-agent/updater/internal/version.version=v{{ .Version }}
- -X github.com/observiq/bindplane-agent/updater/internal/version.gitHash={{ .FullCommit }}
- -X github.com/observiq/bindplane-agent/updater/internal/version.date={{ .Date }}
- -X github.com/observiq/bindplane-otel-collector/updater/internal/version.version=v{{ .Version }}
- -X github.com/observiq/bindplane-otel-collector/updater/internal/version.gitHash={{ .FullCommit }}
- -X github.com/observiq/bindplane-otel-collector/updater/internal/version.date={{ .Date }}
no_unique_dist_dir: false

# https://goreleaser.com/customization/archive/
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ VERSION ?= $(if $(CURRENT_TAG),$(CURRENT_TAG),$(PREVIOUS_TAG))
# Builds just the agent for current GOOS/GOARCH pair
.PHONY: agent
agent:
go build -ldflags "-s -w -X github.com/observiq/bindplane-agent/internal/version.version=$(VERSION)" -tags bindplane -o $(OUTDIR)/collector_$(GOOS)_$(GOARCH)$(EXT) ./cmd/collector
go build -ldflags "-s -w -X github.com/observiq/bindplane-otel-collector/internal/version.version=$(VERSION)" -tags bindplane -o $(OUTDIR)/collector_$(GOOS)_$(GOARCH)$(EXT) ./cmd/collector

# Builds just the updater for current GOOS/GOARCH pair
.PHONY: updater
updater:
cd ./updater/; go build -ldflags "-s -w -X github.com/observiq/bindplane-agent/internal/version.version=$(VERSION)" -o ../$(OUTDIR)/updater_$(GOOS)_$(GOARCH)$(EXT) ./cmd/updater
cd ./updater/; go build -ldflags "-s -w -X github.com/observiq/bindplane-otel-collector/internal/version.version=$(VERSION)" -o ../$(OUTDIR)/updater_$(GOOS)_$(GOARCH)$(EXT) ./cmd/updater

# Builds the updater + agent for current GOOS/GOARCH pair
.PHONY: build-binaries
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

<center>

[![Action Status](https://github.com/observIQ/bindplane-agent/workflows/Build/badge.svg)](https://github.com/observIQ/bindplane-agent/actions)
[![Action Test Status](https://github.com/observIQ/bindplane-agent/workflows/Tests/badge.svg)](https://github.com/observIQ/bindplane-agent/actions)
[![Go Report Card](https://goreportcard.com/badge/github.com/observIQ/bindplane-agent)](https://goreportcard.com/report/github.com/observIQ/bindplane-agent)
[![Action Status](https://github.com/observIQ/bindplane-otel-collector/workflows/Build/badge.svg)](https://github.com/observIQ/bindplane-otel-collector/actions)
[![Action Test Status](https://github.com/observIQ/bindplane-otel-collector/workflows/Tests/badge.svg)](https://github.com/observIQ/bindplane-otel-collector/actions)
[![Go Report Card](https://goreportcard.com/badge/github.com/observIQ/bindplane-otel-collector)](https://goreportcard.com/report/github.com/observIQ/bindplane-otel-collector)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

</center>
Expand All @@ -30,7 +30,7 @@ Tested, verified, and supported by observIQ

To install using the installation script, you may run:
```sh
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh
sudo sh -c "$(curl -fsSlL https://github.com/observIQ/bindplane-otel-collector/releases/latest/download/install_unix.sh)" install_unix.sh
```

To install directly with the appropriate package manager, see [installing on Linux](/docs/installation-linux.md).
Expand All @@ -39,10 +39,10 @@ To install directly with the appropriate package manager, see [installing on Lin

To install the BindPlane Agent on Windows run the Powershell command below to install the MSI with no UI.
```pwsh
msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet
msiexec /i "https://github.com/observIQ/bindplane-otel-collector/releases/latest/download/observiq-otel-collector.msi" /quiet
```

Alternately, for an interactive installation [download the latest MSI](https://github.com/observIQ/bindplane-agent/releases/latest).
Alternately, for an interactive installation [download the latest MSI](https://github.com/observIQ/bindplane-otel-collector/releases/latest).

After downloading the MSI, simply double click it to open the installation wizard. Follow the instructions to configure and install the agent.

Expand All @@ -53,7 +53,7 @@ For more installation information see [installing on Windows](/docs/installation
To install using the installation script, you may run:

```sh
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_macos.sh)" install_macos.sh
sudo sh -c "$(curl -fsSlL https://github.com/observIQ/bindplane-otel-collector/releases/latest/download/install_macos.sh)" install_macos.sh
```

For more installation information see [installing on macOS](/docs/installation-mac.md).
Expand Down
10 changes: 5 additions & 5 deletions cmd/collector/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ import (
_ "time/tzdata"

"github.com/google/uuid"
"github.com/observiq/bindplane-agent/collector"
"github.com/observiq/bindplane-agent/internal/logging"
"github.com/observiq/bindplane-agent/internal/service"
"github.com/observiq/bindplane-agent/internal/version"
"github.com/observiq/bindplane-agent/opamp"
"github.com/observiq/bindplane-otel-collector/collector"
"github.com/observiq/bindplane-otel-collector/internal/logging"
"github.com/observiq/bindplane-otel-collector/internal/service"
"github.com/observiq/bindplane-otel-collector/internal/version"
"github.com/observiq/bindplane-otel-collector/opamp"
"github.com/spf13/pflag"
"go.uber.org/zap"
"gopkg.in/yaml.v3"
Expand Down
2 changes: 1 addition & 1 deletion cmd/collector/main_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import (
"testing"

"github.com/google/uuid"
"github.com/observiq/bindplane-agent/opamp"
"github.com/observiq/bindplane-otel-collector/opamp"
"github.com/oklog/ulid/v2"
"github.com/stretchr/testify/require"
"gopkg.in/yaml.v3"
Expand Down
6 changes: 3 additions & 3 deletions cmd/plugindocgen/go.mod
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
module github.com/observiq/bindplane-agent/plugindocgen
module github.com/observiq/bindplane-otel-collector/plugindocgen

go 1.22.7

require (
github.com/observiq/bindplane-agent/receiver/pluginreceiver v1.66.0
github.com/observiq/bindplane-otel-collector/receiver/pluginreceiver v1.66.0
github.com/spf13/pflag v1.0.5
gopkg.in/yaml.v3 v3.0.1
)
Expand Down Expand Up @@ -124,4 +124,4 @@ require (
gopkg.in/yaml.v2 v2.4.0 // indirect
)

replace github.com/observiq/bindplane-agent/receiver/pluginreceiver => ../../receiver/pluginreceiver
replace github.com/observiq/bindplane-otel-collector/receiver/pluginreceiver => ../../receiver/pluginreceiver
2 changes: 1 addition & 1 deletion cmd/plugindocgen/plugin_doc_generator.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import (
"strings"
"text/template"

"github.com/observiq/bindplane-agent/receiver/pluginreceiver"
"github.com/observiq/bindplane-otel-collector/receiver/pluginreceiver"
"gopkg.in/yaml.v3"
)

Expand Down
4 changes: 2 additions & 2 deletions collector/collector.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ import (
"sync"
"time"

"github.com/observiq/bindplane-agent/factories"
"github.com/observiq/bindplane-agent/internal/measurements"
"github.com/observiq/bindplane-otel-collector/factories"
"github.com/observiq/bindplane-otel-collector/internal/measurements"
"go.opentelemetry.io/collector/otelcol"
"go.uber.org/zap"
)
Expand Down
2 changes: 1 addition & 1 deletion collector/mocks/mock_collector.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion collector/settings_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
"context"
"testing"

"github.com/observiq/bindplane-agent/factories"
"github.com/observiq/bindplane-otel-collector/factories"
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/filelogreceiver"
"github.com/stretchr/testify/require"
"go.opentelemetry.io/collector/component"
Expand Down
2 changes: 1 addition & 1 deletion config/google_cloud_exporter/elasticsearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ See the [prerequisites](../README.md) doc for Google Cloud prerequisites.

## Environment

The provided configuration is suitable for scraping metrics from a single node cluster. For scraping metrics from a multi node cluster, see the Elasticsearch receiver [documentation](https://github.com/observIQ/bindplane-agent/blob/main/docs/receivers.md).
The provided configuration is suitable for scraping metrics from a single node cluster. For scraping metrics from a multi node cluster, see the Elasticsearch receiver [documentation](https://github.com/observIQ/bindplane-otel-collector/blob/main/docs/receivers.md).
2 changes: 1 addition & 1 deletion config/google_cloud_exporter/hostmetrics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Host Metrics does not have setup requirements.

## Process metrics

The host metrics receiver supports per process cpu, memory, disk, and network metrics. This feature requires elevated privileges. On Linux, you must update the service configuration to run the agent as the root user. See the [installation documentation](https://github.com/observIQ/bindplane-agent/blob/main/docs/installation-linux.md#configuring-the-agent) for instructions.
The host metrics receiver supports per process cpu, memory, disk, and network metrics. This feature requires elevated privileges. On Linux, you must update the service configuration to run the agent as the root user. See the [installation documentation](https://github.com/observIQ/bindplane-otel-collector/blob/main/docs/installation-linux.md#configuring-the-agent) for instructions.
2 changes: 1 addition & 1 deletion config/google_cloud_exporter/mongodb_atlas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The Mongodb Atlas Receiver can be used to send Mongodb Atlas metrics to Google C

## Prerequisites

See the [documentation](https://github.com/observIQ/bindplane-agent/blob/main/docs/receivers.md) for Mongodb Atlas prerequisites.
See the [documentation](https://github.com/observIQ/bindplane-otel-collector/blob/main/docs/receivers.md) for Mongodb Atlas prerequisites.

See the [prerequisites](../README.md) doc for Google Cloud prerequisites.

Expand Down
2 changes: 1 addition & 1 deletion config/google_cloud_exporter/mysql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The agent must be installed on the Mysql system.

## Prerequisites

See the [documentation](https://github.com/observIQ/bindplane-agent/blob/main/docs/receivers.md) for Mysql prerequisites.
See the [documentation](https://github.com/observIQ/bindplane-otel-collector/blob/main/docs/receivers.md) for Mysql prerequisites.

See the [prerequisites](../README.md) doc for Google Cloud prerequisites.

Expand Down
2 changes: 1 addition & 1 deletion config/google_cloud_exporter/nginx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ The agent must be installed on the NGINX system.

## Prerequisites

The `ngx_http_stub_status_module` must be enabled. See the [documentation](https://github.com/observIQ/bindplane-agent/blob/main/docs/receivers.md) for NGINX prerequisites.
The `ngx_http_stub_status_module` must be enabled. See the [documentation](https://github.com/observIQ/bindplane-otel-collector/blob/main/docs/receivers.md) for NGINX prerequisites.

See the [prerequisites](../README.md) doc for Google Cloud prerequisites.
2 changes: 1 addition & 1 deletion config/google_cloud_exporter/postgresql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The agent must be installed on the Postgresql system.

## Prerequisites

See the [documentation](https://github.com/observIQ/bindplane-agent/blob/main/docs/receivers.md) for Postgresql prerequisites.
See the [documentation](https://github.com/observIQ/bindplane-otel-collector/blob/main/docs/receivers.md) for Postgresql prerequisites.

See the [prerequisites](../README.md) doc for Google Cloud prerequisites.

Expand Down
2 changes: 1 addition & 1 deletion config/google_cloud_exporter/prometheus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ with the prefix `workload.googleapis.com`.

| Label | Description | Example |
| ----------- | ----------- | ------- |
| `node_id` | The hostname of the agent. Set within the [Google exporter](https://github.com/observIQ/bindplane-agent/tree/main/exporter/googlecloudexporter#metric-processing-steps), and required for [generic_node](https://cloud.google.com/monitoring/api/resources#tag_generic_node) monitored resource type. | `collector-0` |
| `node_id` | The hostname of the agent. Set within the [Google exporter](https://github.com/observIQ/bindplane-otel-collector/tree/main/exporter/googlecloudexporter#metric-processing-steps), and required for [generic_node](https://cloud.google.com/monitoring/api/resources#tag_generic_node) monitored resource type. | `collector-0` |
| `job` | Dervied from the Prometheus receiver's `config.scrape_configs` `job_name` value. This value should represent the applications being scraped by the scrape config. | `nodeexporter` |
| `instance` | The host / ip and port being scraped by the scrape config. | `node-1:9100` |

Expand Down
2 changes: 1 addition & 1 deletion config/google_cloud_exporter/rabbitmq/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The RabbitMQ Receiver can be used to send RabbitMQ metrics to Google Cloud Monit

## Prerequisites

See the [documentation](https://github.com/observIQ/bindplane-agent/blob/main/docs/receivers.md) for RabbitMQ prerequisites.
See the [documentation](https://github.com/observIQ/bindplane-otel-collector/blob/main/docs/receivers.md) for RabbitMQ prerequisites.

See the [prerequisites](../README.md) doc for Google Cloud prerequisites.

Expand Down
2 changes: 1 addition & 1 deletion config/google_managed_prometheus/hostmetrics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ An example configuration is located [here](./config.yaml).

## Process metrics

The host metrics receiver supports per process cpu, memory, disk, and network metrics. This feature requires elevated privileges. On Linux, you must update the service configuration to run the agent as the root user. See the [installation documentation](https://github.com/observIQ/bindplane-agent/blob/main/docs/installation-linux.md#configuring-the-agent) for instructions.
The host metrics receiver supports per process cpu, memory, disk, and network metrics. This feature requires elevated privileges. On Linux, you must update the service configuration to run the agent as the root user. See the [installation documentation](https://github.com/observIQ/bindplane-otel-collector/blob/main/docs/installation-linux.md#configuring-the-agent) for instructions.

## Metrics

Expand Down
2 changes: 1 addition & 1 deletion counter/go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/observiq/bindplane-agent/counter
module github.com/observiq/bindplane-otel-collector/counter

go 1.22.7

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ Please note that the agent must be installed on the system which you wish to col
#### Windows:

```batch
msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet
msiexec /i "https://github.com/observIQ/bindplane-otel-collector/releases/latest/download/observiq-otel-collector.msi" /quiet
```

#### Linux:

```shell
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh
sudo sh -c "$(curl -fsSlL https://github.com/observIQ/bindplane-otel-collector/releases/latest/download/install_unix.sh)" install_unix.sh
```

For more details on installation, see our [Linux](/docs/installation-linux.md), [Windows](/docs/installation-windows.md), and [Mac](/docs/installation-mac.md) installation guides.
Expand Down
12 changes: 6 additions & 6 deletions docs/installation-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ This script may also be used to update an existing installation.

To install using the installation script, you may run:
```sh
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh
sudo sh -c "$(curl -fsSlL https://github.com/observIQ/bindplane-otel-collector/releases/latest/download/install_unix.sh)" install_unix.sh
```

#### Managed Mode

To install the agent with an OpAMP connection configuration set the following flags.

```sh
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh -e <your_endpoint> -s <secret-key>
sudo sh -c "$(curl -fsSlL https://github.com/observIQ/bindplane-otel-collector/releases/latest/download/install_unix.sh)" install_unix.sh -e <your_endpoint> -s <secret-key>
```

To read more about the generated connection configuration file see [OpAMP docs](./opamp.md).
Expand All @@ -31,11 +31,11 @@ To read more about the generated connection configuration file see [OpAMP docs](
To install the agent from a local package use the `-f` with the path to the package.

```sh
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh -f <path_to_package>
sudo sh -c "$(curl -fsSlL https://github.com/observIQ/bindplane-otel-collector/releases/latest/download/install_unix.sh)" install_unix.sh -f <path_to_package>
```

### RPM Installation
First download the RPM package for your architecture from the [releases page](https://github.com/observIQ/bindplane-agent/releases/latest).
First download the RPM package for your architecture from the [releases page](https://github.com/observIQ/bindplane-otel-collector/releases/latest).
Then you may install the package using `rpm`, see this example for installing the amd64 package:

**Note**: Replace `${VERSION}` with the version of the package you downloaded.
Expand All @@ -46,7 +46,7 @@ sudo systemctl enable --now observiq-otel-collector
```

### DEB Installation
First download the DEB package for your architecture from the [releases page](https://github.com/observIQ/bindplane-agent/releases/latest).
First download the DEB package for your architecture from the [releases page](https://github.com/observIQ/bindplane-otel-collector/releases/latest).
Then you may install the package using `dpkg`, see this example for installing the amd64 package:

**Note**: Replace `${VERSION}` with the version of the package you downloaded.
Expand Down Expand Up @@ -131,5 +131,5 @@ sudo dpkg -r observiq-otel-collector

To uninstall an installation made with the install script, run:
```sh
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh -r
sudo sh -c "$(curl -fsSlL https://github.com/observIQ/bindplane-otel-collector/releases/latest/download/install_unix.sh)" install_unix.sh -r
```
6 changes: 3 additions & 3 deletions docs/installation-mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This script may also be used to update an existing installation.

To install using the installation script, you may run:
```sh
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_macos.sh)" install_macos.sh
sudo sh -c "$(curl -fsSlL https://github.com/observIQ/bindplane-otel-collector/releases/latest/download/install_macos.sh)" install_macos.sh
```

Installation artifacts are signed. Information on verifying the signature can be found at [Verifying Artifact Signatures](./verify-signature.md).
Expand All @@ -17,7 +17,7 @@ Installation artifacts are signed. Information on verifying the signature can be
To install the agent with an OpAMP connection configuration set the following flags.

```sh
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_macos.sh)" install_macos.sh -e <your_endpoint> -s <secret-key>
sudo sh -c "$(curl -fsSlL https://github.com/observIQ/bindplane-otel-collector/releases/latest/download/install_macos.sh)" install_macos.sh -e <your_endpoint> -s <secret-key>
```

To read more about the generated connection configuration file see [OpAMP docs](./opamp.md).
Expand Down Expand Up @@ -54,5 +54,5 @@ sudo launchctl unload /Library/LaunchDaemons/com.observiq.collector.plist

To uninstall an installation made with the install script, run:
```sh
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_macos.sh)" install_macos.sh -r
sudo sh -c "$(curl -fsSlL https://github.com/observIQ/bindplane-otel-collector/releases/latest/download/install_macos.sh)" install_macos.sh -r
```
Loading