Skip to content

Commit

Permalink
Add feedback api config to read me
Browse files Browse the repository at this point in the history
  • Loading branch information
@dhee-tree
dhee-tree committed Jan 30, 2025
1 parent 4f26768 commit 43826d7
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# dp-frontend-dataset-controller

==================

An HTTP service for the controlling of data and rendering templates relevant to a particular dataset.

## Configuration

| Environment variable | Default | Description |
| -------------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| API_ROUTER_URL | http://localhost:23200/v1 | The URL of the [dp-api-router](https://github.com/ONSdigital/dp-api-router) |
| API_ROUTER_URL | <http://localhost:23200/v1> | The URL of the [dp-api-router](https://github.com/ONSdigital/dp-api-router) |
| BIND_ADDR | :20200 | The host and port to bind to. |
| CACHE_NAVIGATION_UPDATE_INTERVAL | 10s | How often the navigation cache is updated |
| DEBUG | false | Enable debug mode |
| DOWNLOAD_SERVICE_URL | http://localhost:23600 | The URL of [dp-download-service](https://www.github.com/ONSdigital/dp-download-service). |
| DOWNLOAD_SERVICE_URL | <http://localhost:23600> | The URL of [dp-download-service](https://www.github.com/ONSdigital/dp-download-service). |
| ENABLE_FEEDBACK_API | false | Enable feedback api |
| ENABLE_MULTIVARIATE | false | Enable 2021 [multivariate datasets](https://github.com/ONSdigital/dp-dataset-api/blob/5f9f4218b65aae4803809f4a876e9f72b9bf5305/models/dataset.go#L43) |
| ENABLE_NEW_NAV_BAR | false | Enable new nav bar |
| ENABLE_PROFILER | false | Flag to enable go profiler |
| FEEDBACK_API_URL | <http://localhost:23200/v1/feedback> | The public `dp-api-router` address for feedback, not the internal one |
| GRACEFUL_SHUTDOWN_TIMEOUT | 5s | The graceful shutdown timeout in seconds |
| HEALTHCHECK_CRITICAL_TIMEOUT | 90s | The time taken for the health changes from warning state to critical due to subsystem check failures |
| HEALTHCHECK_INTERVAL | 30s | The time between calling healthcheck endpoints for check subsystems |
| OTEL_BATCH_TIMEOUT | 5s | Interval between pushes to OT Collector |
| OTEL_EXPORTER_OTLP_ENDPOINT | http://localhost:4317 | URL for OpenTelemetry endpoint |
| OTEL_EXPORTER_OTLP_ENDPOINT | <http://localhost:4317> | URL for OpenTelemetry endpoint |
| OTEL_SERVICE_NAME | "dp-frontend-dataset-controller" | Service name to report to telemetry tools |
| OTEL_ENABLED | false | Feature flag to enable OpenTelemetry
| OTEL_ENABLED | false | Feature flag to enable OpenTelemetry |
| PATTERN_LIBRARY_ASSETS_PATH | "" | Pattern library location |
| PPROF_TOKEN | "" | The profiling token to access service profiling |
| SITE_DOMAIN | localhost | |
Expand All @@ -33,7 +33,7 @@ An HTTP service for the controlling of data and rendering templates relevant to
An optional `/debug` endpoint has been added, in order to profile this service via `pprof` go library.
In order to use this endpoint, you will need to enable profiler flag and set a PPROF_TOKEN:

```
```text
export ENABLE_PROFILER=true
export PPROF_TOKEN={generated uuid}
```
Expand All @@ -50,6 +50,6 @@ b) `go tool pprof heap.out`, -o flag to see various options

## Licence

Copyright © 2023, Office for National Statistics (https://www.ons.gov.uk)
Copyright © 2025, Office for National Statistics (<https://www.ons.gov.uk>)

Released under MIT license, see [LICENSE](LICENSE.md) for details.

0 comments on commit 43826d7

Please sign in to comment.