Skip to content
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

docs: add additional details for debugging #517

Merged
merged 2 commits into from
Sep 6, 2024
Merged

docs: add additional details for debugging #517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd3ca5b
docs: add additional details for debugging
gastonfournier Sep 6, 2024
8930e30
Add security note to deploying
gastonfournier Sep 6, 2024
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,8 @@ Unleash Edge adheres to Semantic Versioning (SemVer) on the API and CLI layers.

## Debugging

You can inspect the internal state of edge by looking at http://<your-edge-url>/internal-backstage/tokens to see the tokens that edge knows about and http://<your-edge-url>/internal-backstage/features to see the current state of features (note that `/internal-backstage/*` should not be exposed to the public).

To enable verbose logging, adjust the `RUST_LOG` environment variable. For example, to see logs originating directly from Edge but not its dependencies, you can raise the default log level from `error` to `warning` and set Edge to `debug`, like this:

```sh
Expand Down
6 changes: 5 additions & 1 deletion docs/deploying.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Deploying

## Security considerations

Anything under /internal-backstage should be protected from public access as it exposes internal state of unleash-edge.

## Running Unleash Edge

Edge provides a range of powerful ways in which you can run it. For a standard production configuration we recommend the
Expand Down Expand Up @@ -114,4 +118,4 @@ $ echo $?

If you're hosting Edge with a self-signed certificate using the tls cli arguments, you should use
the `--ca-certificate-file <file_containing_your_ca_and_key_in_pem_format>` flag (or the CA_CERTIFICATE_FILE environment
variable) to allow the health checker to trust the self signed certificate.
variable) to allow the health checker to trust the self signed certificate.