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.

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

[doc] Update the default path used by the configuration #284

Merged
merged 1 commit into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
The **Quarkus Logging Manager** Extension provides you endpoints to visualize and manage the
log level of your loggers.

| Endpoint | Http Method | Description |
| ------------- |:-------------:|:-----:|
| `/logging-manager` | `GET` | Returns the list of all loggers, with information about the configured and effective level |
| `/logging-manager?loggerName={loggerName}` | `GET` | Returns the logger specified by this name, with information about the configured and effective level |
| `/logging-manager` | `POST` | Changes the log level of the specified logger |
| `/logging-manager/levels` | `GET` | Get all the available level |
| Endpoint | Http Method | Description |
|------------------------------------------|:-------------:|:-----:|
| `/q/logging-manager` | `GET` | Returns the list of all loggers, with information about the configured and effective level |
| `/q/logging-manager?loggerName={loggerName}` | `GET` | Returns the logger specified by this name, with information about the configured and effective level |
| `/q/logging-manager` | `POST` | Changes the log level of the specified logger |
| `/q/logging-manager/levels` | `GET` | Get all the available level |

## Security
Security of endpoints is important and we do not want to allow unknown people to know (or worse, change!) the log levels of
Expand All @@ -22,12 +22,13 @@ All you have to do is define your application.properties similar to this:
quarkus.http.auth.basic=true # If you want basic auth. Multiple auth mechanism are supported

quarkus.http.auth.policy.admin-access.roles-allowed=admin
quarkus.http.auth.permission.roles1.paths=/loggers
quarkus.http.auth.permission.roles1.paths=/q/logging-manager
quarkus.http.auth.permission.roles1.policy=admin-access
```
And, in case you chose Basic Auth, provide a IdentityProvider (either by implementing one or adding an extension that provides
one).
Quarkus will take care of matching the paths (in this case `/loggers` to the policy you defined and granting or denying access).
Quarkus will take care of matching the paths (in this case `/q/logging-manager` to the policy you defined and
granting or denying access).
Then you can also secure all the endpoints in your application using this configuration.


Expand Down
Binary file modified openapi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading