Grafana Proxy

The technical documentation of the grafana-proxy microservice, which proxies request from Grafana to the backend services.

less than a minute

This microservice is still in development and is not considered stable for production use

How it works

The grafana-proxy microservice serves an HTTP REST endpoint located at /api/v1/{service}/{data}. The service parameter specifies the backend service to which the request should be proxied, like factoryinput or factoryinsight. The data parameter specifies the API endpoint to forward to the backend service. The body of the HTTP request is used as the payload for the proxied request.

Kubernetes resources

Deployment: united-manufacturing-hub-grafanaproxy
Service:
- External LoadBalancer: united-manufacturing-hub-grafanaproxy-service at port 2096

Configuration

Environment variables

Environment variables
Variable name	Description	Type	Allowed values	Default
`DEBUG_ENABLE_FGTRACE`	Enables the use of the fgtrace library. Not reccomended for production	string	`true`, `false`	`false`
`FACTORYINPUT_BASE_URL`	URL of factoryinput	string	Any	http://united-manufacturing-hub-factoryinput-service
`FACTORYINPUT_KEY`	Specifies the password for the admin user for factoryinput	string	Any	Random UUID
`FACTORYINPUT_USER`	Specifies the admin user for factoryinput	string	Any	factoryinput
`FACTORYINSIGHT_BASE_URL`	URL of factoryinsight	string	Any	http://united-manufacturing-hub-factoryinsight-service
`MICROSERVICE_NAME`	Name of the microservice. Used for tracing	string	Any	united-manufacturing-hub-factoryinput
`SERIAL_NUMBER`	Serial number of the cluster. Used for tracing	string	Any	default
`VERSION`	The version of the API used. Each version also enables all the previous ones	int	Any	1

Last modified May 5, 2023: feat: finishing touches (1147002)