Skip to content

docs: document Log Analytics prerequisite for metric charts (refs #6) #7

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

Open
lokic233 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document Log Analytics prerequisite for metric charts (refs #6) #7

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
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -766,6 +766,27 @@ In both Cluster Director and GKE, you will find the following pages:
metrics. You can also view these metrics Cloud Logging under Logging > Logs
Explorer. Metrics recorded via `metrics.record()` are written as log entries
and can be filtered or used to create log-based metrics.

> **Prerequisite — enable Log Analytics on the `_Default` log bucket.** The
> model-metrics and performance-metrics time series charts render their data
> with a Log Analytics query against the project's `_Default` log bucket. If
> Log Analytics is not enabled on that bucket, these charts fail (the widget
> shows a generic "Something went wrong in the backend" / "0 time series"),
> even though the metric data is present in Cloud Logging and Profiles /
> system metrics render fine. Enable it once per project (non-destructive
> upgrade — existing logs stay queryable, no added cost, cannot be disabled):
>
> ```bash
> gcloud logging buckets update _Default --location=global \
> --enable-analytics --project=PROJECT_ID
> ```
>
> This requires the `logging.buckets.update` permission (for example
> `roles/logging.configWriter`).
>
> **Note:** Log Analytics does not backfill. Only logs ingested *after* it is
> enabled are queryable, so runs that completed before enabling it will still
> show empty charts — launch a new run to verify.
4. Profiles tab with all profile sessions (programmatic or on-demand) for that particular run, with links to the Xprof viewer (Xprof UI will open in a separate browser tab). In this profiles tab, you can also capture an on-demand profile session directly from the UI.

### Package Workload with SDK with Dockerfile for GKE
Expand Down