Chore: Add function documentation for new functions (Prometheus visual query editor) (#45745)

* add missing function documentation

* added trigonometric functions
This commit is contained in:
Stephanie Closson 2022-03-01 07:42:32 -04:00 committed by GitHub
parent 36b039a10e
commit 251d6ed0e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -18,6 +18,81 @@ export const RATE_RANGES: CompletionItem[] = [
export const OPERATORS = ['by', 'group_left', 'group_right', 'ignoring', 'on', 'offset', 'without'];
export const LOGICAL_OPERATORS = ['or', 'and', 'unless'];
const TRIGONOMETRIC_FUNCTIONS: CompletionItem[] = [
{
label: 'acos',
insertText: 'acos',
detail: 'acos(v instant-vector)',
documentation: 'calculates the arccosine of all elements in v',
},
{
label: 'acosh',
insertText: 'acosh',
detail: 'acosh(v instant-vector)',
documentation: 'calculates the inverse hyperbolic cosine of all elements in v',
},
{
label: 'asin',
insertText: 'asin',
detail: 'asin(v instant-vector)',
documentation: 'calculates the arcsine of all elements in v',
},
{
label: 'asinh',
insertText: 'asinh',
detail: 'asinh(v instant-vector)',
documentation: 'calculates the inverse hyperbolic sine of all elements in v',
},
{
label: 'atan',
insertText: 'atan',
detail: 'atan(v instant-vector)',
documentation: 'calculates the arctangent of all elements in v',
},
{
label: 'atanh',
insertText: 'atanh',
detail: 'atanh(v instant-vector)',
documentation: 'calculates the inverse hyperbolic tangent of all elements in v',
},
{
label: 'cos',
insertText: 'cos',
detail: 'cos(v instant-vector)',
documentation: 'calculates the cosine of all elements in v',
},
{
label: 'cosh',
insertText: 'cosh',
detail: 'cosh(v instant-vector)',
documentation: 'calculates the hyperbolic cosine of all elements in v',
},
{
label: 'sin',
insertText: 'sin',
detail: 'sin(v instant-vector)',
documentation: 'calculates the sine of all elements in v',
},
{
label: 'sinh',
insertText: 'sinh',
detail: 'sinh(v instant-vector)',
documentation: 'calculates the hyperbolic sine of all elements in v',
},
{
label: 'tan',
insertText: 'tan',
detail: 'tan(v instant-vector)',
documentation: 'calculates the tangent of all elements in v',
},
{
label: 'tanh',
insertText: 'tanh',
detail: 'tanh(v instant-vector)',
documentation: 'calculates the hyperbolic tangent of all elements in v',
},
];
const AGGREGATION_OPERATORS: CompletionItem[] = [
{
label: 'sum',
@ -83,6 +158,7 @@ const AGGREGATION_OPERATORS: CompletionItem[] = [
export const FUNCTIONS = [
...AGGREGATION_OPERATORS,
...TRIGONOMETRIC_FUNCTIONS,
{
insertText: 'abs',
label: 'abs',
@ -142,6 +218,12 @@ export const FUNCTIONS = [
documentation:
'Returns the number of elements in a time series vector as a scalar. This is in contrast to the `count()` aggregation operator, which always returns a vector (an empty one if the input vector is empty) and allows grouping by labels via a `by` clause.',
},
{
insertText: 'deg',
label: 'deg',
detail: 'deg(v instant-vector)',
documentation: 'Converts radians to degrees for all elements in v',
},
{
insertText: 'day_of_month',
label: 'day_of_month',
@ -286,6 +368,12 @@ export const FUNCTIONS = [
documentation:
'Returns the month of the year for each of the given times in UTC. Returned values are from 1 to 12, where 1 means January etc.',
},
{
insertText: 'pi',
label: 'pi',
detail: 'pi()',
documentation: 'Returns pi',
},
{
insertText: 'predict_linear',
label: 'predict_linear',
@ -293,6 +381,12 @@ export const FUNCTIONS = [
documentation:
'Predicts the value of time series `t` seconds from now, based on the range vector `v`, using simple linear regression.',
},
{
insertText: 'rad',
label: 'rad',
detail: 'rad(v instant-vector)',
documentation: 'Converts degrees to radians for all elements in v',
},
{
insertText: 'rate',
label: 'rate',