module · Observability

Newrelic

New Relic — alert policies, dashboards, users, and alert-policy state (NerdGraph GraphQL API).

Namespace: weave newrelic Env: NEW_RELIC_API_KEY

Commands

State kinds

Observability

Setup

Configure credentials via environment variables. We recommend sourcing them through 1Password or your secrets manager rather than committing them to the shell rc.

Official API reference

weave commands for this module are checked against the vendor's published API.

NerdGraph API

Variable	Description	Status
NEW_RELIC_API_KEY	Required for authentication.	required
NEW_RELIC_ACCOUNT_ID	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave newrelic --help
weave doctor   # reports NEW_RELIC_API_KEY status

Capabilities

What this module can do, by entity and verb. ✓ means a working CLI surface; · means not (yet) wired.

Entity	find	list	show	do	snapshot	diff	apply
alert	·	✓	·	·	✓	✓	✓
dashboard	·	✓	·	·	·	·	·
user	✓	✓	·	·	·	·	·

Commands

Every registered CLI command, grouped by verb. Each example uses placeholder arguments — substitute real values for your environment.

find (1)

find user

read

Find a user by exact email.

weave newrelic find user <email>

list (3)

list alerts

read

List alert policies (requires NEW_RELIC_ACCOUNT_ID).

weave newrelic list alerts <arg>

list dashboards

read

List dashboards (entity search).

weave newrelic list dashboards <arg>

list users

read

List users across authentication domains.

weave newrelic list users <arg>

snapshot / diff / apply are generated automatically from the State Kinds declared on this module — see the State kinds section below for per-kind details. Workflow: snapshot → edit YAML → diff → apply --yes (or confirm interactively; apply --dry-run previews the same diff).

State kinds

Resources this module can snapshot and diff; apply where the kind supports live writes (see Round-trip per kind). Always run diff before apply; use --yes in automation after review. Files live under .weave-state/newrelic/.

This module is on the thinner integration path — use snapshot / diff for audit; confirm apply per kind below before relying on writes.

alerts

snapshot diff apply

New Relic alert policies — rename / set incidentPreference via alertsPolicyUpdate.

Scope: —
Round-trip: Full round-trip — snapshot, diff, apply.

State file skeleton

module: newrelic
kind: alerts
items:
  - # <fields specific to this kind — see snapshot output>

Workflows

End-to-end recipes from operators who already run this module in production. Copy, adapt, and put under change-control.

Alert policies audit

Snapshot, diff, and apply alerts.

weave newrelic snapshot alerts
$EDITOR .weave-state/newrelic/alerts.yaml
weave newrelic diff alerts
weave newrelic apply alerts

Terraform parity

For each Terraform resource in the canonical provider, here's the equivalent live-API verb in weave. Use this as a migration cheat-sheet, not a 1:1 contract — weave deliberately stays in the live-state lane, not the desired-state lane.

Terraform resource	weave equivalent
newrelic_alerts	weave newrelic snapshot/diff/apply alerts Snapshot/diff for audit; confirm apply on the module page.

Troubleshooting & source

Missing credentials

Run weave doctor — it reports which env vars (including NEW_RELIC_API_KEY) are set and which are blank.

Unexpected behaviour from a state apply

Re-run weave newrelic diff <kind> to confirm the controller's current state, then re-snapshot before the next apply. The driver always re-snapshots before diffing.

Open the source

The module lives at https://github.com/andy-broyles/weavewhatever/tree/main/src/weave/modules/newrelic. File a bug or feature request at https://github.com/andy-broyles/weavewhatever/issues.