Skip to content

docs: Update README with installation instructions #69

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.

Sign up for GitHub

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

Merged
lufia merged 1 commit into from
Dec 9, 2025
Merged

docs: Update README with installation instructions #69

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions distributions/otelcol-mackerel/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@ $ docker run -e MACKEREL_APIKEY=your_api_key mackerel/otelcol-mackerel:latest

### Linux (deb Package)

```sh
curl -fsSL https://mackerel.io/file/script/opentelemetry-collector-mackerel/setup-apt.sh | MACKEREL_APIKEY='<YOUR_API_KEY>' sh
```

<details>
<summary>Manual installation</summary>

```console
$ # Get the asset URL for the corresponding architecture from the GitHub release page.
$ sudo apt install https://github.com/mackerelio/opentelemetry-collector-mackerel/releases/download/v0.2.0/otelcol-mackerel_0.2.0_linux_amd64.deb
Expand All @@ -47,8 +54,17 @@ $ sudo systemctl status otelcol-mackerel.service --no-pager --lines=0
└─30011 /usr/bin/otelcol-mackerel --config=mackerel:default
```

</details>

### Linux (rpm Package)

```sh
curl -fsSL https://mackerel.io/file/script/opentelemetry-collector-mackerel/setup-yum.sh | MACKEREL_APIKEY='<YOUR_API_KEY>' sh
```

<details>
<summary>Manual installation</summary>

```console
$ # Get the asset URL for the corresponding architecture from the GitHub release page.
$ sudo apt install https://github.com/mackerelio/opentelemetry-collector-mackerel/releases/download/v0.2.0/otelcol-mackerel_0.2.0_linux_amd64.rpm
Expand All @@ -66,6 +82,8 @@ $ sudo systemctl status otelcol-mackerel.service --no-pager --lines=0
└─30011 /usr/bin/otelcol-mackerel --config=mackerel:default
```

</details>

## Options

You can modify the config from the default by setting additional environment variables.
Expand Down