RepoMirrors
/
prometheus
mirror of https://github.com/prometheus/prometheus
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

codemirror-promql: Add request header to client (#13118) 

With this commit we make it possible to adjust the request headers sent
to Prometheus by the codemirror-promql extension. This enables
customizing the headers sent, without re-implementing the Prometheus
client completely.

Signed-off-by: Jacob Baungard Hansen <jacobbaungard@redhat.com>
This commit is contained in:
Jacob Baungård Hansen 2023-11-10 11:22:32 +01:00 committed by GitHub
parent e8585e4d44
commit 80d2f992ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
web/ui/module/codemirror-promql/README.md
View File

@ -161,6 +161,15 @@ You can change it to use the HTTP method `GET` if you prefer.
const promQL = new PromQLExtension().setComplete({remote: {httpMethod: 'GET'}}) const promQL = new PromQLExtension().setComplete({remote: {httpMethod: 'GET'}})
``` ```
###### HTTP request headers
If you need to send specific HTTP headers along with the requests to Prometheus, you can adjust that as follows:
```typescript
const customHeaders = new Headers({'header-name': 'test-value'});
const promql = new PromQLExtension().setComplete({remote: {requestHeaders: customHeaders}})
```
###### Override the API Prefix ###### Override the API Prefix
The default Prometheus Client, when building the query to get data from Prometheus, is using an API prefix which is by The default Prometheus Client, when building the query to get data from Prometheus, is using an API prefix which is by

10
web/ui/module/codemirror-promql/src/client/prometheus.ts
View File

@ -58,6 +58,7 @@ export interface PrometheusConfig {
cache?: CacheConfig; cache?: CacheConfig;
httpMethod?: 'POST' | 'GET'; httpMethod?: 'POST' | 'GET';
apiPrefix?: string; apiPrefix?: string;
requestHeaders?: Headers;
} }
interface APIResponse<T> { interface APIResponse<T> {
@ -84,6 +85,7 @@ export class HTTPPrometheusClient implements PrometheusClient {
// For some reason, just assigning via "= fetch" here does not end up executing fetch correctly // For some reason, just assigning via "= fetch" here does not end up executing fetch correctly
// when calling it, thus the indirection via another function wrapper. // when calling it, thus the indirection via another function wrapper.
private readonly fetchFn: FetchFn = (input: RequestInfo, init?: RequestInit): Promise<Response> => fetch(input, init); private readonly fetchFn: FetchFn = (input: RequestInfo, init?: RequestInit): Promise<Response> => fetch(input, init);
private requestHeaders: Headers = new Headers();
constructor(config: PrometheusConfig) { constructor(config: PrometheusConfig) {
this.url = config.url ? config.url : ''; this.url = config.url ? config.url : '';
@ -100,6 +102,9 @@ export class HTTPPrometheusClient implements PrometheusClient {
if (config.apiPrefix) { if (config.apiPrefix) {
this.apiPrefix = config.apiPrefix; this.apiPrefix = config.apiPrefix;
} }
if (config.requestHeaders) {
this.requestHeaders = config.requestHeaders;
}
} }
labelNames(metricName?: string): Promise<string[]> { labelNames(metricName?: string): Promise<string[]> {
@ -221,6 +226,11 @@ export class HTTPPrometheusClient implements PrometheusClient {
} }
private fetchAPI<T>(resource: string, init?: RequestInit): Promise<T> { private fetchAPI<T>(resource: string, init?: RequestInit): Promise<T> {
if (init) {
init.headers = this.requestHeaders;
} else {
init = { headers: this.requestHeaders };
}
return this.fetchFn(this.url + resource, init) return this.fetchFn(this.url + resource, init)
.then((res) => { .then((res) => {
if (!res.ok && ![badRequest, unprocessableEntity, serviceUnavailable].includes(res.status)) { if (!res.ok && ![badRequest, unprocessableEntity, serviceUnavailable].includes(res.status)) {