railwatch 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AGENTS.md +1 -1
- data/CHANGELOG.md +29 -0
- data/README.md +44 -166
- data/docs/ai-and-mcp.md +9 -9
- data/docs/configuration.md +419 -392
- data/docs/getting-started.md +10 -8
- data/docs/records.md +306 -280
- data/docs/replacing-sentry.md +6 -6
- data/docs/source-maps.md +1 -1
- data/docs/testing.md +18 -21
- data/docs/troubleshooting.md +126 -87
- data/lib/railwatch/minitest.rb +4 -3
- data/lib/railwatch/secret_safety.rb +3 -1
- data/lib/railwatch/subscribers/exceptions.rb +20 -0
- data/lib/railwatch/subscribers/process_info.rb +5 -2
- data/lib/railwatch/version.rb +1 -1
- data/lib/tasks/railwatch_tasks.rake +4 -4
- metadata +2 -2
data/docs/getting-started.md
CHANGED
|
@@ -35,7 +35,7 @@ bin/rails generate railwatch:install \
|
|
|
35
35
|
shell history and process listings.
|
|
36
36
|
- A token is written to `.env` only when Git confirms that `.env` is ignored.
|
|
37
37
|
A tracked or non-ignored dotenv file is refused; use Rails credentials, a
|
|
38
|
-
deployment secret manager, or add `.env` to `.gitignore first. Token values
|
|
38
|
+
deployment secret manager, or add `.env` to `.gitignore` first. Token values
|
|
39
39
|
are never printed by the generator.
|
|
40
40
|
- `--url=` sets `RAILWATCH_INGEST_URL`, for a self-hosted platform. Leave
|
|
41
41
|
it off to use the default, `https://railwatch.rebulk.com`.
|
|
@@ -73,7 +73,7 @@ update `RAILWATCH_TOKEN`.
|
|
|
73
73
|
bin/rails railwatch:token # prints the URL to create/copy a token
|
|
74
74
|
```
|
|
75
75
|
|
|
76
|
-
A token looks like `
|
|
76
|
+
A token looks like `rw_` followed by 40 characters. The gem is
|
|
77
77
|
completely inert without one: `Railwatch.enabled?` is `config.enabled &&
|
|
78
78
|
token.present?`, so an app with no token installs no subscribers and
|
|
79
79
|
ships nothing.
|
|
@@ -85,7 +85,7 @@ bin/rails railwatch:doctor
|
|
|
85
85
|
```
|
|
86
86
|
|
|
87
87
|
```
|
|
88
|
-
✓ token:
|
|
88
|
+
✓ token: rw_9Qv... (43 chars)
|
|
89
89
|
✓ ingest url: https://railwatch.rebulk.com
|
|
90
90
|
✓ ingest reachable: GET https://railwatch.rebulk.com/ingest/ping
|
|
91
91
|
✓ request middleware: Railwatch::Middleware::Request at position 0
|
|
@@ -95,10 +95,12 @@ bin/rails railwatch:doctor
|
|
|
95
95
|
✓ ignored record types: none
|
|
96
96
|
```
|
|
97
97
|
|
|
98
|
-
It exits non-zero
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
98
|
+
It exits non-zero on three lines: `token` (missing), `token storage`
|
|
99
|
+
(a plaintext token in a tracked file), and `ingest reachable`. The rest
|
|
100
|
+
of the checklist is informational. Run it after the token is in place:
|
|
101
|
+
`ingest reachable` sends the token, so a missing or wrong token makes
|
|
102
|
+
the platform answer 401 and that line is `✗` as well. Every line and
|
|
103
|
+
what to do about a `✗` is in [`troubleshooting.md`](troubleshooting.md).
|
|
102
104
|
|
|
103
105
|
`bin/rails railwatch:status` is the one-line version: it pings
|
|
104
106
|
`{ingest_url}/ingest/ping` and prints the ingest URL, deploy, and server.
|
|
@@ -232,7 +234,7 @@ run or a release page.
|
|
|
232
234
|
Environment variables only:
|
|
233
235
|
|
|
234
236
|
```sh
|
|
235
|
-
RAILWATCH_TOKEN=
|
|
237
|
+
RAILWATCH_TOKEN=rw_...
|
|
236
238
|
RAILWATCH_INGEST_URL=https://railwatch.rebulk.com # only when self-hosting
|
|
237
239
|
RAILWATCH_DEPLOY=<release identifier>
|
|
238
240
|
```
|