google / google/slo-generator

Discrepancy on environment variable naming in Cloud Monitoring backends

Open
#285 0 comments 0 reactions 1 assignee Claimed by @lvaylet View on GitHub
bug docs documentation p/cloud_monitoring p/cloud_monitoring_mql p/cloud_service_monitoring
Dominant language
Python
Stars
564
Forks
88
PR merge metrics
No merged PRs in 30d

Description

The `project_id` variable is referred to as `STACKDRIVER_HOST_PROJECT_ID` in `samples/config.yaml`, `samples/config_export.yaml` and `samples.env.sample` while `samples/README.md` mentions a `WORKSPACE_PROJECT_ID` variable with the same purpose:

`samples/config.yaml`:

```yaml
backends:
cloud_monitoring:
project_id: ${STACKDRIVER_HOST_PROJECT_ID}
cloud_monitoring_mql:
project_id: ${STACKDRIVER_HOST_PROJECT_ID}
cloud_service_monitoring:
project_id: ${STACKDRIVER_HOST_PROJECT_ID}
```

`samples/README.md`:

```
### `cloud_monitoring`

| Environment variable | Description |
| --- | --- |
| `WORKSPACE_PROJECT_ID` | Cloud Monitoring host project ID |
[...]

### `cloud_monitoring_mql`

| Environment variable | Description |
| --- | --- |
| `WORKSPACE_PROJECT_ID` | Cloud Monitoring host project ID |
[...]

### `cloud_service_monitoring`

| Environment variable | Description |
| --- | --- |
| `WORKSPACE_PROJECT_ID` | Cloud Monitoring host project ID |
[...]
```
Users might get confused, even if the explanation is as simple as [Google Cloud renaming Stackdriver to Cloud Operations](https://bluemedora.com/google-operations-is-here-but-wheres-stackdriver/).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.