IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Prometheus: Update default HTTP method to POST for existing data sources (#34599)

Browse Source 
* Change default method to POST

* Update comment

* Add tests

* Update Whats new

* Update docs/sources/whatsnew/whats-new-in-v8-0.md

Co-authored-by: Julien Pivotto <roidelapluie@inuits.eu>

* Update docs/sources/whatsnew/whats-new-in-v8-0.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Update docs/sources/whatsnew/whats-new-in-v8-0.md

Co-authored-by: Julien Pivotto <roidelapluie@inuits.eu>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
This commit is contained in:
Ivana Huckova 2021-05-25 18:56:46 +02:00 committed by GitHub
parent 0e0ed43153
commit 93c5c8345c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 92 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/sources/administration/provisioning.md
View File

@ -152,7 +152,7 @@ Since not all datasources have the same configuration settings we only have the
| timeInterval | string | Prometheus, Elasticsearch, InfluxDB, MySQL, PostgreSQL and MSSQL | Lowest interval/step value that should be used for this data source. |
| httpMode | string | Influxdb | HTTP Method. 'GET', 'POST', defaults to GET |
| maxSeries | number | Influxdb | Max number of series/tables that Grafana processes |
| httpMethod | string | Prometheus | HTTP Method. 'GET', 'POST', defaults to GET |
| httpMethod | string | Prometheus | HTTP Method. 'GET', 'POST', defaults to POST |
| customQueryParameters | string | Prometheus | Query parameters to add, as a URL-encoded string. |
| esVersion | string | Elasticsearch | Elasticsearch version (E.g. `7.0.0`, `7.6.1`) |
| timeField | string | Elasticsearch | Which field that should be used as timestamp |

16
docs/sources/whatsnew/whats-new-in-v8-0.md
View File

@ -24,7 +24,7 @@ Library panels allow users to build panels that can be used in multiple dashboar
### Real-time streaming
Data sources can now send real-time updates to dashboards over a websocket connection. This can be used with the [MQTT data source](https://github.com/grafana/mqtt-datasource).
Data sources can now send real-time updates to dashboards over a websocket connection. This can be used with the [MQTT data source](https://github.com/grafana/mqtt-datasource).
In addition to data source integration, events can be sent to dashboards by posting metrics to the new live endpoint: `/api/live/push endpoint`.
@ -48,7 +48,7 @@ This release introduces a new histogram panel visualization.
### Time series visualization updates
The Time series is out of beta! We are removing the `Beta` tag and graduating the Time series visualization to a stable state.
The Time series is out of beta! We are removing the `Beta` tag and graduating the Time series visualization to a stable state.
- **Time series** is now the default visualization option, replacing the **Graph (old)**.
- The Time series panel now supports stacking. For more information, refer to [Graph stacked time series]({{< relref "../panels/visualizations/time-series/graph-time-series-stacking.md" >}}).
@ -60,7 +60,7 @@ The Time series is out of beta! We are removing the `Beta` tag and graduating t
### Pie chart visualization updates
The Pie chart is out of beta! We are removing the `Beta` tag and graduating the Pie chart visualization to a stable state.
The Pie chart is out of beta! We are removing the `Beta` tag and graduating the Pie chart visualization to a stable state.
### Panel editor updates
@ -115,7 +115,7 @@ Grafana 8.0 includes many performance enhancements.
#### Initial startup and load performance
We reduced the Grafana initial download size massively, approximately 40%. This means that on slower or mobile connections, the initial login page or home dashboard will load much faster.
We reduced the Grafana initial download size massively, approximately 40%. This means that on slower or mobile connections, the initial login page or home dashboard will load much faster.
All panels that have migrated from Flot to uPlot will also render two to three times faster because the library is much more efficient. Right now, this includes the Time series, Stat, Timeline, Histogram, and Barchart panel visualizations.
@ -206,9 +206,9 @@ You can now configure generic OAuth with empty scopes. This allows OAuth Identit
##### Added OAuth support for strict parsing of role_attribute_path
You can now configure generic OAuth with strict parsing of the `role_attribute_path`. By default, if th `role_attribute_path` property does not return a role, then the user is assigned the `Viewer` role. You can disable the role assignment by setting `role_attribute_strict = true`. It denies user access if no role or an invalid role is returned.
You can now configure generic OAuth with strict parsing of the `role_attribute_path`. By default, if the `role_attribute_path` property does not return a role, then the user is assigned the `Viewer` role. You can disable the role assignment by setting `role_attribute_strict = true`. It denies user access if no role or an invalid role is returned.
#### Singlestat panel deprecated
#### Singlestat panel deprecated
Support for Singlestat panel has been discontinued. When you upgrade to version 8.0, all existing Singlestat panels automatically becomes Stat panels.
Stat panel is available as plugin.
@ -243,3 +243,7 @@ Documentation was updated to reflect these changes.
### Elasticsearch: Use application/x-ndjson content type for multi-search requests
For multi-search requests, we now use the correct application/x-ndjson content type instead of the incorrect application/json. Although this should be transparent to most of the users, if you are running Elasticsearch behind a proxy, then be sure that your proxy correctly handles requests with this content type.
### Prometheus: Update default HTTP method to POST for existing data sources
The default HTTP method for Prometheus data source is now POST, previously it was GET. The POST APIs are there since January 2018 (Prometheus 2.1.0) and they have fewer limitations than the GET APIs. Users with Prometheus instance with version < 2.1.0 that use the default HTTP method should update their HTTP method to GET.

14
public/app/plugins/datasource/prometheus/configuration/PromSettings.test.tsx
View File

@ -88,7 +88,7 @@ describe('PromSettings', () => {
describe('PromSettings component', () => {
const defaultProps = createDefaultConfigOptions();
it('should show POST httpMethod if no httpMethod and no url', () => {
it('should show POST httpMethod if no httpMethod', () => {
const options = defaultProps;
options.url = '';
options.jsonData.httpMethod = '';
@ -100,18 +100,6 @@ describe('PromSettings', () => {
);
expect(screen.getByText('POST')).toBeInTheDocument();
});
it('should show GET httpMethod if no httpMethod and url', () => {
const options = defaultProps;
options.url = 'test_url';
options.jsonData.httpMethod = '';
render(
<div>
<PromSettings onOptionsChange={() => {}} options={options} />
</div>
);
expect(screen.getByText('GET')).toBeInTheDocument();
});
it('should show POST httpMethod if POST httpMethod is configured', () => {
const options = defaultProps;
options.url = 'test_url';

9
public/app/plugins/datasource/prometheus/configuration/PromSettings.tsx
View File

@ -20,15 +20,10 @@ type Props = Pick<DataSourcePluginOptionsEditorProps<PromOptions>, 'options' | '
export const PromSettings = (props: Props) => {
const { options, onOptionsChange } = props;
/**
* We want to change the default httpMethod to 'POST' for all of the new Prometheus data sources instances (no url) added in 7.5+.
* We are explicitly adding httpMethod, as previously it could be undefined and defaulted to 'GET'.
* Undefined httpMethod is still going to be considered 'GET' for backward compatibility reasons, but if users open data
* source settings it is going to be set to 'GET' explicitly and it will be selected in httpMethod dropdown as 'GET'.
* */
// We are explicitly adding httpMethod so it is correctly displayed in dropdown. This way, it is more predictable for users.
if (!options.jsonData.httpMethod) {
options.url ? (options.jsonData.httpMethod = 'GET') : (options.jsonData.httpMethod = 'POST');
options.jsonData.httpMethod = 'POST';
}
return (

104
public/app/plugins/datasource/prometheus/datasource.test.ts
View File

@ -127,12 +127,6 @@ describe('PrometheusDatasource', () => {
});
describe('customQueryParams', () => {
const promDs = new PrometheusDatasource(
{ ...instanceSettings, jsonData: { customQueryParameters: 'customQuery=123' } as any },
templateSrvStub as any,
timeSrvStub as any
);
const target = { expr: 'test{job="testjob"}', format: 'time_series', refId: '' };
function makeQuery(target: PromQuery) {
return {
@ -141,31 +135,87 @@ describe('PrometheusDatasource', () => {
interval: '60s',
} as any;
}
it('added to metadata request', () => {
promDs.metadataRequest('/foo');
expect(fetchMock.mock.calls.length).toBe(1);
expect(fetchMock.mock.calls[0][0].url).toBe('proxied/foo?customQuery=123');
});
it('adds params to timeseries query', () => {
promDs.query(makeQuery(target));
expect(fetchMock.mock.calls.length).toBe(1);
expect(fetchMock.mock.calls[0][0].url).toBe(
'proxied/api/v1/query_range?query=test%7Bjob%3D%22testjob%22%7D&start=60&end=180&step=60&customQuery=123'
describe('with GET http method', () => {
const promDs = new PrometheusDatasource(
{ ...instanceSettings, jsonData: { customQueryParameters: 'customQuery=123', httpMethod: 'GET' } as any },
templateSrvStub as any,
timeSrvStub as any
);
});
it('adds params to exemplars query', () => {
promDs.query(makeQuery({ ...target, exemplar: true }));
// We do also range query for single exemplars target
expect(fetchMock.mock.calls.length).toBe(2);
expect(fetchMock.mock.calls[0][0].url).toContain('&customQuery=123');
expect(fetchMock.mock.calls[1][0].url).toContain('&customQuery=123');
it('added to metadata request', () => {
promDs.metadataRequest('/foo');
expect(fetchMock.mock.calls.length).toBe(1);
expect(fetchMock.mock.calls[0][0].url).toBe('proxied/foo?customQuery=123');
});
it('adds params to timeseries query', () => {
promDs.query(makeQuery(target));
expect(fetchMock.mock.calls.length).toBe(1);
expect(fetchMock.mock.calls[0][0].url).toBe(
'proxied/api/v1/query_range?query=test%7Bjob%3D%22testjob%22%7D&start=60&end=180&step=60&customQuery=123'
);
});
it('adds params to exemplars query', () => {
promDs.query(makeQuery({ ...target, exemplar: true }));
// We do also range query for single exemplars target
expect(fetchMock.mock.calls.length).toBe(2);
expect(fetchMock.mock.calls[0][0].url).toContain('&customQuery=123');
expect(fetchMock.mock.calls[1][0].url).toContain('&customQuery=123');
});
it('adds params to instant query', () => {
promDs.query(makeQuery({ ...target, instant: true }));
expect(fetchMock.mock.calls.length).toBe(1);
expect(fetchMock.mock.calls[0][0].url).toContain('&customQuery=123');
});
});
it('adds params to instant query', () => {
promDs.query(makeQuery({ ...target, instant: true }));
expect(fetchMock.mock.calls.length).toBe(1);
expect(fetchMock.mock.calls[0][0].url).toContain('&customQuery=123');
describe('with POST http method', () => {
const promDs = new PrometheusDatasource(
{ ...instanceSettings, jsonData: { customQueryParameters: 'customQuery=123', httpMethod: 'POST' } as any },
templateSrvStub as any,
timeSrvStub as any
);
it('added to metadata request with non-POST endpoint', () => {
promDs.metadataRequest('/foo');
expect(fetchMock.mock.calls.length).toBe(1);
expect(fetchMock.mock.calls[0][0].url).toBe('proxied/foo?customQuery=123');
});
it('added to metadata request with POST endpoint', () => {
promDs.metadataRequest('/api/v1/labels');
expect(fetchMock.mock.calls.length).toBe(1);
expect(fetchMock.mock.calls[0][0].url).toBe('proxied/api/v1/labels');
expect(fetchMock.mock.calls[0][0].data.customQuery).toBe('123');
});
it('adds params to timeseries query', () => {
promDs.query(makeQuery(target));
expect(fetchMock.mock.calls.length).toBe(1);
expect(fetchMock.mock.calls[0][0].url).toBe('proxied/api/v1/query_range');
expect(fetchMock.mock.calls[0][0].data).toEqual({
customQuery: '123',
query: 'test{job="testjob"}',
step: 60,
end: 180,
start: 60,
});
});
it('adds params to exemplars query', () => {
promDs.query(makeQuery({ ...target, exemplar: true }));
// We do also range query for single exemplars target
expect(fetchMock.mock.calls.length).toBe(2);
expect(fetchMock.mock.calls[0][0].data.customQuery).toBe('123');
expect(fetchMock.mock.calls[1][0].data.customQuery).toBe('123');
});
it('adds params to instant query', () => {
promDs.query(makeQuery({ ...target, instant: true }));
expect(fetchMock.mock.calls.length).toBe(1);
expect(fetchMock.mock.calls[0][0].data.customQuery).toBe('123');
});
});
});

2
public/app/plugins/datasource/prometheus/datasource.ts
View File

@ -78,7 +78,7 @@ export class PrometheusDatasource extends DataSourceApi<PromQuery, PromOptions>
this.withCredentials = instanceSettings.withCredentials;
this.interval = instanceSettings.jsonData.timeInterval || '15s';
this.queryTimeout = instanceSettings.jsonData.queryTimeout;
this.httpMethod = instanceSettings.jsonData.httpMethod || 'GET';
this.httpMethod = instanceSettings.jsonData.httpMethod || 'POST';
this.directUrl = instanceSettings.jsonData.directUrl;
this.exemplarTraceIdDestinations = instanceSettings.jsonData.exemplarTraceIdDestinations;
this.ruleMappings = {};