Skip to content

Commit

Permalink
Add basic troubleshooting steps (#145)
Browse files Browse the repository at this point in the history
  • Loading branch information
elefeint authored Sep 9, 2019
1 parent 4709a08 commit 7c87a45
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,9 @@ yourself by downloading a couple jars.
[Here's an example](autoconfigure/storage-stackdriver#quick-start) of
integrating Stackdriver storage.

## Troubleshooting translation issues
## Troubleshooting

### Translation issues

When using a component that sends data to Stackdriver, if you see nothing in the console,
try enabling DEBUG logging on the translation component. If using Spring Boot (ex normal
Expand Down Expand Up @@ -114,6 +116,25 @@ labels {
}
```

### Healthcheck API

If you are running Zipkin server, `/health` HTTP endpoint can be used to check service health.

### gRPC Headers

If you suspect an issue between Zipkin server and Stackdriver, inspecting gRPC headers may be useful.
Set `STACKDRIVER_HTTP_LOGGING` environment variable to `HEADERS` to log gRPC status information.

### GCP console

If you believe that spans are reaching Stackdriver, verify what happens to them from the GCP side by visiting APIs & Services > Dashboard > Stackdriver Trace API > Metrics section.

* Is there any traffic at all? If not, then the requests are likely not reaching Stackdriver at all. Check your applications/proxies to make sure requests go to the right place.
* Are there errors? If so, narrow down the source of errors by selecting specific Credentials and Methods values from the filter drop-downs on top and seeing the effect in "Errors by API method" chart or "Methods" table.
* If all writes are failing, check that your service account has access to `cloudtrace.agent` role or `cloudtrace.traces.patch` permission.
* If reads are failing, check for `cloudtrace.user` role or the specific permission (full permissions list).
NOTE: read and write permissions are separate; only the admin role has both.

## Artifacts
All artifacts publish to the group ID "io.zipkin.gcp". We use a common
release version for all components.
Expand Down

0 comments on commit 7c87a45

Please sign in to comment.