Proxy#
Perses can serve as a proxy for various supported datasource types. This is especially useful when:
- The datasource is not accessible from your browser.
- The datasource is protected by an authentication mechanism.
HTTP Proxy#
How it works#
Depending on the datasource scope (Global, Project, Local), the URL to access the datasource will be different.
- For a global scope, the URL to access a datasource in the global scope is:
- For a project scope, the URL to access a datasource in the project scope is:
- For a local scope, the URL to access a datasource in the local scope is:
/proxy/projects/<project-name>/dashboards/<dashboard-name>/datasources/<datasource-name>/<datasource_api_path>
For example, if we have a Prometheus Global datasource named brometheus, the following URI will return the Prometheus
config:
/api/v1/status/config is the path to get the Prometheus config if you were contacting the Prometheus API directly.
When contacting one of these URLs, Perses will first get the datasource from the database based on the provided information in the URI. Then, if a secret is associated with the datasource, Perses will retrieve the secret from the database and use it to inject the secret in the request. Finally, Perses will forward the request to the datasource and return the response to the client.
sequenceDiagram
actor client as Client
participant backend as Perses Backend
participant db as Database
participant datasource as Datasource
client ->> backend: GET timeseries from datasource
backend ->> backend: Check if client has permission to access the datasource
backend ->> db: Get datasource
backend ->> db: Get secret
backend ->> backend: Modify the request by injecting<br/> the secret and changing the URL
backend ->> datasource: Forward the request
datasource ->> backend: Return the response
backend ->> client: Forward the responseSQL Proxy#
When using the SQLProxy kind, the Perses server takes the request body from the FE and then executes the query against the datsource's database.
How it works#
Depending on the datasource scope (Global, Project, Local), the URL to access the datasource will be different.
The difference between the HTTP proxy and SQL proxy is that the URL is pointing to the datsource path only
and the request needs to be POST
- For a global scope, the URL to access a datasource in the global scope is:
- For a project scope, the URL to access a datasource in the project scope is:
- For a local scope, the URL to access a datasource in the local scope is:
The request JSON body should have the following schema:
When contacting one of these URLs, Perses will first get the datasource from the database based on the provided information in the URI. Then, if a secret is associated with the datasource, Perses will retrieve the secret from the database and use it to inject the secret in the request. Finally, Perses will execute the query to the SQL datasource and return the response in CSV format to the client.
sequenceDiagram
actor client as Client
participant backend as Perses Backend
participant db as Database
participant datasource as Datasource
client ->> backend: GET timeseries from datasource
backend ->> backend: Check if client has permission to access the datasource
backend ->> db: Get datasource
backend ->> db: Get secret
backend ->> backend: Build the SQL database connection
backend ->> datasource: Execute the SQL query against the database
datasource ->> backend: Return the response in CSV format
backend ->> client: Forward the response