Skip to content

Commit

Permalink
Adds UI_ENABLED mapping to make more obvious how to disable it (#3731)
Browse files Browse the repository at this point in the history
Signed-off-by: Adrian Cole <adrian@tetrate.io>
  • Loading branch information
codefromthecrypt authored Feb 19, 2024
1 parent 154f2f2 commit d43412e
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 5 deletions.
6 changes: 6 additions & 0 deletions build-bin/mlc_config.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
{
"ignorePatterns": [
{
"pattern": "https://chromewebstore.google.com/detail/*"
},
{
"pattern": "https://stackoverflow.com/questions/tagged/spring-boot"
},
{
"pattern": "https://oss.sonatype.org/content/repositories/snapshots"
},
Expand Down
4 changes: 2 additions & 2 deletions zipkin-lens/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,12 @@ need to debug the page (they will only work with the local dev server, not a pro

### React Developer Tools

Chrome: https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi
Chrome: https://chromewebstore.google.com/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi
Firefox: https://addons.mozilla.org/en-US/firefox/addon/react-devtools/

### Redux DevTools

Chrome: https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd
Chrome: https://chromewebstore.google.com/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd
Firefox: https://addons.mozilla.org/en-US/firefox/addon/reduxdevtools/

## Running behind a reverse proxy
Expand Down
6 changes: 4 additions & 2 deletions zipkin-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,11 +131,12 @@ Here are the top-level configuration of Zipkin:
* `QUERY_PORT`: Listen port for the HTTP API and web UI; Defaults to 9411
* `QUERY_ENABLED`: `false` disables the HTTP read endpoints under '/api/v2'. This also disables the
UI, as it relies on the API. If your only goal is to restrict search, use `SEARCH_ENABLED` instead.
Defaults to true
If your only goal is to disable the UI, use `UI_ENABLED` instead. Defaults to true
* `SEARCH_ENABLED`: `false` disables searching in the query API and any indexing or post-processing
in the collector to support search. This does not disable the entire UI, as trace by ID and
dependency queries still operate. Disable this when you use another service (such as logs) to find
trace IDs. Defaults to true
* `UI_ENABLED`: `false` disables the web UI, mounted at '/zipkin'. Defaults to true
* `QUERY_TIMEOUT`: Sets the hard timeout for query requests. Accepts any duration string (e.g., 100ms).
A value of 0 will disable the timeout completely. Defaults to 11s.
* `QUERY_LOG_LEVEL`: Log level written to the console; Defaults to INFO
Expand Down Expand Up @@ -166,7 +167,8 @@ mention this because configuration of Spring implies vast responsibility and our
conserved for Zipkin related tasks.

## UI
Zipkin has a web UI, automatically included in the exec jar, and is hosted by default on port 9411.
Zipkin has a web UI, automatically included in the exec jar, and is hosted by default on port 9411
under the path '/zipkin'. This is enabled unless `UI_ENABLED` or `QUERY_ENABLED` are set to false.

When the UI loads, it reads default configuration from the `/config.json` endpoint.

Expand Down
2 changes: 1 addition & 1 deletion zipkin-server/src/main/resources/zipkin-server-shared.yml
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ zipkin:
max-active: ${MYSQL_MAX_CONNECTIONS:10}
use-ssl: ${MYSQL_USE_SSL:false}
ui:
enabled: ${QUERY_ENABLED:true}
enabled: ${UI_ENABLED:${QUERY_ENABLED:true}}
## Values below here are mapped to ZipkinUiProperties, served as /config.json
# Default limit for Find Traces
query-limit: 10
Expand Down

0 comments on commit d43412e

Please sign in to comment.