public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[v8.5.x] Cloudwatch: Add template variable query function for listing log grou… (#50161)

Browse Source 
* Cloudwatch: Add template variable query function for listing log groups (#50100)

* cloud-datasources mob! :shipit:

* cloud-datasources mob! :shipit:

lastFile:public/app/plugins/datasource/cloudwatch/components/VariableQueryEditor/VariableQueryEditor.tsx

* mob next [ci-skip] [ci skip] [skip ci]

lastFile:public/app/plugins/datasource/cloudwatch/variables.ts

* cloud-datasources mob! 👶

lastFile:public/app/plugins/datasource/cloudwatch/components/VariableQueryEditor/VariableQueryEditor.test.tsx

* cloud-datasources mob! 👶

lastFile:public/app/plugins/datasource/cloudwatch/components/VariableQueryEditor/VariableQueryEditor.test.tsx

* mob next [ci-skip] [ci skip] [skip ci]

lastFile:public/app/plugins/datasource/cloudwatch/components/VariableQueryEditor/VariableQueryEditor.test.tsx

* cloud-datasources mob! :shipit:

lastFile:public/app/plugins/datasource/cloudwatch/variables.test.ts

* cloud-datasources mob! ☕

* prettier md

Co-authored-by: Kevin Yu <kevinwcyu@users.noreply.github.com>
Co-authored-by: Andres <andres.martinez@grafana.com>
Co-authored-by: Erik Sundell <erik.sundell87@gmail.com>
Co-authored-by: Adam Simpson <adam@adamsimpson.net>
(cherry picked from commit bcf8320e07)

* Fixed test
This commit is contained in:
Yaelle Chaudy
2022-06-03 16:58:55 +02:00
committed by GitHub
parent 450314947b
commit f037b23f9f
7 changed files with 59 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/datasources/aws-cloudwatch/template-queries-cloudwatch.md
+1
View File
@@ -29,6 +29,7 @@ Read more about the available dimensions in the [CloudWatch Metrics and Dimensio
| `EC2 Instance Attributes` | Returns a list of attributes matching the specified `region`, `attribute_name`, and `filters`. |
| `Resource ARNs` | Returns a list of ARNs matching the specified `region`, `resource_type` and `tags`. |
| `Statistics` | Returns a list of all the standard statistics. |
| `LogGroups` | Returns a list of all log groups matching the specified `region`. |
For details about the metrics CloudWatch provides, please refer to the [CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html).
public/app/plugins/datasource/cloudwatch/components/VariableQueryEditor/VariableQueryEditor.test.tsx
+20 -3
View File
@@ -66,7 +66,7 @@ describe('VariableEditor', () => {
render(<VariableQueryEditor {...props} />);
await waitFor(() => {
const querySelect = screen.queryByRole('combobox', { name: 'Query Type' });
const querySelect = screen.queryByRole('combobox', { name: 'Query type' });
expect(querySelect).toBeInTheDocument();
expect(screen.queryByText('Regions')).toBeInTheDocument();
// Should not render any fields besides Query Type
@@ -88,7 +88,7 @@ describe('VariableEditor', () => {
render(<VariableQueryEditor {...props} />);
await waitFor(() => {
const querySelect = screen.queryByRole('combobox', { name: 'Query Type' });
const querySelect = screen.queryByRole('combobox', { name: 'Query type' });
expect(querySelect).toBeInTheDocument();
expect(screen.queryByText('Metrics')).toBeInTheDocument();
const regionSelect = screen.queryByRole('combobox', { name: 'Region' });
@@ -116,7 +116,7 @@ describe('VariableEditor', () => {
};
render(<VariableQueryEditor {...props} />);
const querySelect = screen.queryByLabelText('Query Type');
const querySelect = screen.queryByLabelText('Query type');
expect(querySelect).toBeInTheDocument();
expect(screen.queryByText('Dimension Values')).toBeInTheDocument();
const regionSelect = screen.getByRole('combobox', { name: 'Region' });
@@ -140,4 +140,21 @@ describe('VariableEditor', () => {
});
});
});
describe('LogGroups queryType is selected', () => {
it('should only render region and prefix', async () => {
const props = defaultProps;
props.query = {
...defaultQuery,
queryType: VariableQueryType.LogGroups,
};
render(<VariableQueryEditor {...props} />);
await waitFor(() => {
screen.getByLabelText('Log group prefix');
});
screen.queryByRole('combobox', { name: 'Region' });
expect(screen.queryByLabelText('Namespace')).not.toBeInTheDocument();
});
});
});
public/app/plugins/datasource/cloudwatch/components/VariableQueryEditor/VariableQueryEditor.tsx
+13 -6
View File
@@ -22,6 +22,7 @@ const queryTypes: Array<{ value: string; label: string }> = [
{ value: VariableQueryType.EC2InstanceAttributes, label: 'EC2 Instance Attributes' },
{ value: VariableQueryType.ResourceArns, label: 'Resource ARNs' },
{ value: VariableQueryType.Statistics, label: 'Statistics' },
{ value: VariableQueryType.LogGroups, label: 'Log Groups' },
];
export const VariableQueryEditor = ({ query, datasource, onChange }: Props) => {
@@ -82,6 +83,7 @@ export const VariableQueryEditor = ({ query, datasource, onChange }: Props) => {
VariableQueryType.EBSVolumeIDs,
VariableQueryType.EC2InstanceAttributes,
VariableQueryType.ResourceArns,
VariableQueryType.LogGroups,
].includes(parsedQuery.queryType);
const hasNamespaceField = [
VariableQueryType.Metrics,
@@ -95,7 +97,7 @@ export const VariableQueryEditor = ({ query, datasource, onChange }: Props) => {
value={parsedQuery.queryType}
options={queryTypes}
onChange={(value: VariableQueryType) => onQueryChange({ ...parsedQuery, queryType: value })}
label="Query Type"
label="Query type"
/>
{hasRegionField && (
<VariableQueryField
@@ -126,7 +128,7 @@ export const VariableQueryEditor = ({ query, datasource, onChange }: Props) => {
value={dimensionKey || null}
options={dimensionKeys}
onChange={(value: string) => onQueryChange({ ...parsedQuery, dimensionKey: value })}
label="Dimension Key"
label="Dimension key"
/>
<VariableTextField
value={query.dimensionFilters}
@@ -149,9 +151,8 @@ export const VariableQueryEditor = ({ query, datasource, onChange }: Props) => {
<>
<VariableTextField
value={parsedQuery.attributeName}
placeholder="attribute name"
onBlur={(value: string) => onQueryChange({ ...parsedQuery, attributeName: value })}
label="Attribute Name"
label="Attribute name"
/>
<VariableTextField
value={parsedQuery.ec2Filters}
@@ -166,9 +167,8 @@ export const VariableQueryEditor = ({ query, datasource, onChange }: Props) => {
<>
<VariableTextField
value={parsedQuery.resourceType}
placeholder="resource type"
onBlur={(value: string) => onQueryChange({ ...parsedQuery, resourceType: value })}
label="Resource Type"
label="Resource type"
/>
<VariableTextField
value={parsedQuery.tags}
@@ -178,6 +178,13 @@ export const VariableQueryEditor = ({ query, datasource, onChange }: Props) => {
/>
</>
)}
{parsedQuery.queryType === VariableQueryType.LogGroups && (
<VariableTextField
value={query.logGroupPrefix ?? ''}
onBlur={(value: string) => onQueryChange({ ...parsedQuery, logGroupPrefix: value })}
label="Log group prefix"
/>
)}
</>
);
};
public/app/plugins/datasource/cloudwatch/components/VariableQueryEditor/VariableTextField.tsx
+1 -1
View File
@@ -7,10 +7,10 @@ const TEXT_WIDTH = 100;
interface VariableTextFieldProps {
onBlur: (value: string) => void;
placeholder: string;
value: string;
label: string;
tooltip?: string;
placeholder?: string;
}
export const VariableTextField: FC<VariableTextFieldProps> = ({ label, onBlur, placeholder, value, tooltip }) => {
public/app/plugins/datasource/cloudwatch/types.ts
+2
View File
@@ -378,6 +378,7 @@ export enum VariableQueryType {
EC2InstanceAttributes = 'ec2InstanceAttributes',
ResourceArns = 'resourceARNs',
Statistics = 'statistics',
LogGroups = 'logGroups',
}
export interface VariableQuery extends DataQuery {
@@ -392,4 +393,5 @@ export interface VariableQuery extends DataQuery {
attributeName: string;
resourceType: string;
tags: string;
logGroupPrefix?: string;
}
public/app/plugins/datasource/cloudwatch/variables.test.ts
+11
View File
@@ -22,6 +22,7 @@ ds.datasource.getRegions = jest.fn().mockResolvedValue([{ label: 'a', value: 'a'
ds.datasource.getNamespaces = jest.fn().mockResolvedValue([{ label: 'b', value: 'b' }]);
ds.datasource.getMetrics = jest.fn().mockResolvedValue([{ label: 'c', value: 'c' }]);
ds.datasource.getDimensionKeys = jest.fn().mockResolvedValue([{ label: 'd', value: 'd' }]);
ds.datasource.describeLogGroups = jest.fn().mockResolvedValue(['a', 'b']);
const getDimensionValues = jest.fn().mockResolvedValue([{ label: 'e', value: 'e' }]);
const getEbsVolumeIds = jest.fn().mockResolvedValue([{ label: 'f', value: 'f' }]);
const getEc2InstanceAttribute = jest.fn().mockResolvedValue([{ label: 'g', value: 'g' }]);
@@ -191,4 +192,14 @@ describe('variables', () => {
{ text: 'SampleCount', value: 'SampleCount', expandable: true },
]);
});
describe('log groups', () => {
it('should call describe log groups', async () => {
const result = await variables.execute({ ...defaultQuery, queryType: VariableQueryType.LogGroups });
expect(result).toEqual([
{ text: 'a', value: 'a', expandable: true },
{ text: 'b', value: 'b', expandable: true },
]);
});
});
});
public/app/plugins/datasource/cloudwatch/variables.ts
+11
View File
@@ -48,6 +48,8 @@ export class CloudWatchVariableSupport extends CustomVariableSupport<CloudWatchD
return this.handleResourceARNsQuery(query);
case VariableQueryType.Statistics:
return this.handleStatisticsQuery();
case VariableQueryType.LogGroups:
return this.handleLogGroupsQuery(query);
}
} catch (error) {
console.error(`Could not run CloudWatchMetricFindQuery ${query}`, error);
@@ -55,6 +57,15 @@ export class CloudWatchVariableSupport extends CustomVariableSupport<CloudWatchD
}
}
async handleLogGroupsQuery({ region, logGroupPrefix }: VariableQuery) {
const logGroups = await this.datasource.describeLogGroups({ region, logGroupNamePrefix: logGroupPrefix });
return logGroups.map((s) => ({
text: s,
value: s,
expandable: true,
}));
}
async handleRegionsQuery() {
const regions = await this.datasource.getRegions();
return regions.map((s: { label: string; value: string }) => ({