Skip to content

Commit

Permalink
Reimplement docs changes from #13877
Browse files Browse the repository at this point in the history
  • Loading branch information
pmac committed Nov 13, 2023
1 parent 394494c commit d608932
Showing 1 changed file with 13 additions and 18 deletions.
31 changes: 13 additions & 18 deletions docs/attribution/0001-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -355,13 +355,19 @@ link click events that we want to measure.

## Debugging pings

For all non-production environments, bedrock will automatically set a
debug view tag for all pings. This means that when running on localhost,
on a demo, or on a staging environment, ping data will be viewable in
the [Glean debug dashboard](https://debug-ping-preview.firebaseapp.com/)
which can be used to test that pings are working correctly. All bedrock
debug pings will register in the debug dashboard with the tag name
`bedrock`.
Glean supports debugging pings via a set of flags that can be enabled directly
in the browser's web console.

- `window.Glean.setLogPings(true)` (enable verbose ping logging in the web console).
- `window.Glean.setDebugViewTag('bedrock')` (send pings to the [Glean debug dashboard](https://debug-ping-preview.firebaseapp.com/) with the tag name `bedrock`).

!!! note

After enabling Glean debugging in the web console, it will be remembered
when navigating across pages using `sessionStorage`. To stop debugging,
you need to either close the browser tab, or delete the items from
`sessionStorage`. You can disable ping logging by calling
`window.Glean.setLogPings(false)`.

## Filtering out non-production pings

Expand All @@ -370,17 +376,6 @@ or `non-prod`, depending on the environment. This is present in all
pings in the `client_info` section, and is useful for filtering out
non-production data in telemetry dashboards.

## Logging pings in the console

When running bedrock locally, you can also set the following environment
variable in your `.env`\` file to automatically log pings in the
browser's web console. This can be especially useful when making
updates to analytics code.

```
GLEAN_LOG_PINGS=True
```

## Defining metrics and pings

All of the data we send to the Glean pipeline is defined in YAML
Expand Down

0 comments on commit d608932

Please sign in to comment.