README
¶
dp-frontend-dataset-controller
An HTTP service for the controlling of data relevant to a particular dataset.
Configuration
| Environment variable | Default | Description |
|---|---|---|
| BIND_ADDR | :20200 | The host and port to bind to. |
| RENDERER_URL | http://localhost:20010 | The URL of dp-frontend-renderer. |
| DATASET_API_URL | http://localhost:22000 | The URL of dp-dataset-api. |
| FILTER_API_URL | http://localhost:22100 | The URL of dp-filter-api. |
| ZEBEDEE_URL | http://localhost:8082 | The URL of zebedee. |
| DOWNLOAD_SERVICE_URL | http://localhost:23600 | The URL of dp-download-service. |
| MAIL_HOST | "" | The host for the mail server. |
| MAIL_PORT | "" | The port for the mail server. |
| MAIL_USER | "" | A user on the mail server. |
| MAIL_PASSWORD | "" | The password for the mail server user. |
| FEEDBACK_TO | "" | Receiver email address for feedback. |
| FEEDBACK_FROM | "" | Sender email address for feedback. |
| GRACEFUL_SHUTDOWN_TIMEOUT | 5s | The graceful shutdown timeout in seconds |
| HEALTHCHECK_INTERVAL | 30s | The time between calling healthcheck endpoints for check subsystems |
| HEALTHCHECK_CRITICAL_TIMEOUT | 90s | The time taken for the health changes from warning state to critical due to subsystem check failures |
| ENABLE_PROFILER | false | Flag to enable go profiler |
| PPROF_TOKEN | "" | The profiling token to access service profiling |
Feedback service
The feedback endpoints in this service rely on access to an SMTP service to process feedback.
In order to submit feedback locally, you must have an SMTP service running (try MailHog)
and update the MAIL_* and FEEDBACK_* variables configured for this app.
Profiling
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:
export ENABLE_PROFILER=true
export PPROF_TOKEN={generated uuid}
Then you can us the profiler as follows:
1- Start service, load test or if on environment wait for a number of requests to be made.
2- Send authenticated request and store response in a file (this can be best done in command line like so: curl <host>:<port>/debug/pprof/heap -H "Authorization: Bearer {generated uuid} > heap.out - see pprof documentation on other endpoints
3- View profile either using a web ui to navigate data (a) or using pprof on command line to navigate data (b)
a) go tool pprof -http=:8080 heap.out
b) go tool pprof heap.out, -o flag to see various options
Licence
Copyright © 2017 2020, Office for National Statistics (https://www.ons.gov.uk)
Released under MIT license, see LICENSE for details.
Documentation
¶
There is no documentation for this package.
Source Files
Directories