Skip to content
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -375,4 +375,4 @@ then run `scout config validate --file your-config.yaml`.
command reference

[prod-ready]: /blog/production-ready-otel-collector
[config-validate-docs]: /scout-cli/open-source/config-validate
[config-validate-docs]: /scout-cli/otel-config/config-validate
6 changes: 3 additions & 3 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ for a quick win and a clear next step.
## I want to use the CLI

- [Install Scout CLI](/scout-cli/installation)
- [Generate an OTel Collector config](/scout-cli/open-source/config-init)
- [Validate a collector config](/scout-cli/open-source/config-validate)
- [Query logs, traces, and metrics](/scout-cli/platform/logs)
- [Generate an OTel Collector config](/scout-cli/otel-config/config-init)
- [Validate a collector config](/scout-cli/otel-config/config-validate)
- [Query logs, traces, and metrics](/scout-cli/scout-access/logs)

## I want CI/CD observability

Expand Down
30 changes: 15 additions & 15 deletions docs/scout-cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,32 +21,32 @@ Scout platform to query logs, metrics, traces, alerts, and service topology β€”
use the open-source config commands to validate, generate, and test
OpenTelemetry Collector configurations without a backend.

## Platform Commands
## Scout Access

These commands require authentication with a
[Scout](https://base14.io) backend.

| Command | Description |
|---------|-------------|
| [login](./platform/login.md) | Authenticate with the Scout platform |
| [logout](./platform/logout.md) | Remove stored credentials |
| [status](./platform/status.md) | Check authentication status |
| [context](./platform/context.md) | Manage multiple account contexts |
| [alerts](./platform/alerts.md) | Query alert history |
| [logs](./platform/logs.md) | Query service logs |
| [metrics](./platform/metrics.md) | Query service metrics |
| [traces](./platform/traces.md) | Query distributed traces |
| [service-map](./platform/service-map.md) | Visualize service topology |

## Open Source Commands
| [login](./scout-access/login.md) | Authenticate with the Scout platform |
| [logout](./scout-access/logout.md) | Remove stored credentials |
| [status](./scout-access/status.md) | Check authentication status |
| [context](./scout-access/context.md) | Manage multiple account contexts |
| [alerts](./scout-access/alerts.md) | Query alert history |
| [logs](./scout-access/logs.md) | Query service logs |
| [metrics](./scout-access/metrics.md) | Query service metrics |
| [traces](./scout-access/traces.md) | Query distributed traces |
| [service-map](./scout-access/service-map.md) | Visualize service topology |

## OTel Config

These commands work entirely offline with no Scout account required.

| Command | Description |
|---------|-------------|
| [config validate](./open-source/config-validate.md) | Validate an OTel Collector YAML config |
| [config init](./open-source/config-init.md) | Generate a production-ready OTel Collector config |
| [config test](./open-source/config-test.md) | Live-test an OTel Collector config |
| [config validate](./otel-config/config-validate.md) | Validate an OTel Collector YAML config |
| [config init](./otel-config/config-init.md) | Generate a production-ready OTel Collector config |
| [config test](./otel-config/config-test.md) | Live-test an OTel Collector config |

:::tip No account needed
The `scout config` commands are fully open source. You can validate, generate,
Expand Down
4 changes: 2 additions & 2 deletions docs/scout-cli/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ scout --version

## Next Steps

- **Platform users** β€” [Authenticate with Scout](./platform/login.md) to start
- **Platform users** β€” [Authenticate with Scout](./scout-access/login.md) to start
querying telemetry data
- **Open-source users** β€” [Generate an OTel Collector config](./open-source/config-init.md)
- **Open-source users** β€” [Generate an OTel Collector config](./otel-config/config-init.md)
to get started without a backend
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"label": "Open Source Commands",
"label": "OTel Config",
"position": 4,
"collapsed": false,
"link": {
"type": "generated-index",
"title": "Open Source Commands",
"title": "OTel Config",
"description": "Offline commands for validating, generating, and testing OpenTelemetry Collector configurations. No Scout backend required."
}
}
8 changes: 4 additions & 4 deletions docs/scout-cli/reference/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,20 @@ environment variables when both are set.

| Variable | Description | Default | Used By |
|----------|-------------|---------|---------|
| `SCOUT_ACCOUNT_SLUG` | Default account slug | β€” | [login](../platform/login.md) |
| `SCOUT_AUTH_URL` | Authentication server URL | `https://id.base14.io` | [login](../platform/login.md) |
| `SCOUT_ACCOUNT_SLUG` | Default account slug | β€” | [login](../scout-access/login.md) |
| `SCOUT_AUTH_URL` | Authentication server URL | `https://id.base14.io` | [login](../scout-access/login.md) |

## API

| Variable | Description | Default | Used By |
|----------|-------------|---------|---------|
| `SCOUT_API_URL` | Override the Scout API base URL | Auto-discovered on login | All platform commands |
| `SCOUT_ACCOUNTS_API_URL` | Override the accounts discovery API URL | `https://api.base14.io` | [login](../platform/login.md) |
| `SCOUT_ACCOUNTS_API_URL` | Override the accounts discovery API URL | `https://api.base14.io` | [login](../scout-access/login.md) |

## OTel Collector Authentication

These variables are referenced in configs generated by
[`scout config init`](../open-source/config-init.md):
[`scout config init`](../otel-config/config-init.md):

| Variable | Description |
|----------|-------------|
Expand Down
2 changes: 1 addition & 1 deletion docs/scout-cli/reference/global-flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ scout -v logs payment-service --raw 2>debug.log | jq .

- [Environment Variables](./environment-variables.md) β€” configure Scout CLI
via environment
- [context](../platform/context.md) β€” manage account contexts persistently
- [context](../scout-access/context.md) β€” manage account contexts persistently
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"label": "Platform Commands",
"label": "Scout Access",
"position": 3,
"collapsed": false,
"link": {
"type": "generated-index",
"title": "Platform Commands",
"title": "Scout Access",
"description": "Commands that interact with the Scout backend for authentication, querying telemetry data, and managing account contexts."
}
}
File renamed without changes.
File renamed without changes.
Loading