Skip to content

Commit 5aa3949

Browse files
authored
update ASL reference docs (#231)
Fix some known issues and expand on some of the operators.
1 parent b617a2b commit 5aa3949

File tree

188 files changed

+5192
-1413
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

188 files changed

+5192
-1413
lines changed

docs/api/graph/axis-bounds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Note the `&l=0` and `&u=60e3` parameters.
7474
/api/v1/graph?e=2012-01-01T09:00&s=e-1d&tz=UTC&l=0&u=60e3&q=name,sps,:eq,nf.cluster,(,nccp-xbox,nccp-silverlight,),:in,:and,:sum,(,nf.cluster,),:by
7575
@@@
7676

77-
!!! Note
77+
!!! Note
7878
It is possible to define the boundaries beyond the range of the data source
7979
so that a graph appears empty.
8080

docs/api/graph/basics.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Putting it all together:
2828
The resulting [PNG] plot displays time along the X axis, automatically scaled to the proper
2929
time range. The Y [axis labels] are scaled using metric prefixes to show the measured value.
3030
A [legend] is displayed under the plot with the name(s) of the expression results and a set
31-
of statistics computed on the plotted data for the time window. The small text at the very
31+
of statistics computed on the plotted data for the time window. The small text at the very
3232
bottom reflect query parameters and step size along with some processing statistics.
3333

3434
[PNG]: outputs.md
@@ -88,8 +88,8 @@ Example that [negates](../../asl/ref/neg.md) the value of a line:
8888
/api/v1/graph?e=2012-01-01T00:00&q=name,sps,:eq,:neg&s=e-2d
8989
@@@
9090

91-
Example that [negates](../../asl/ref/neg.md) and then applies
92-
[absolute value](../../asl/ref/abs.md) to get the original value back (since all values were
91+
Example that [negates](../../asl/ref/neg.md) and then applies
92+
[absolute value](../../asl/ref/abs.md) to get the original value back (since all values were
9393
positive in the input):
9494

9595
@@@ atlas-uri { hilite=:abs }
@@ -102,7 +102,7 @@ positive in the input):
102102

103103
## Binary Operations
104104

105-
Lines can be combined using binary math operators such as [add](../../asl/ref/add.md) or
105+
Lines can be combined using binary math operators such as [add](../../asl/ref/add.md) or
106106
[multiply](../../asl/ref/mul.md). Example using [divide](../../asl/ref/div.md):
107107

108108
@@@ atlas-uri { hilite=:div }

docs/api/graph/color-palettes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,9 +135,9 @@ Shades of red.
135135

136136
## Custom
137137

138-
A custom color palette can be provided for a graph by using a list of comma separated
139-
[hex color](../../asl/ref/color.md) values following the ASL list format `(,HEX,HEX,HEX,)`.
140-
This is mainly used to customize the colors for the result of a group by where you
138+
A custom color palette can be provided for a graph by using a list of comma separated
139+
[hex color](../../asl/ref/color.md) values following the ASL list format `(,HEX,HEX,HEX,)`.
140+
This is mainly used to customize the colors for the result of a group by where you
141141
cannot set the color for each line using the list.
142142

143143
@@@ atlas-uri

docs/api/graph/graph.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
The Graph API is the primary means to retrieve data from an Atlas store.
22

3-
The default response is a PNG image plotting data matching the
4-
[Atlas Stack Language](../../asl/tutorial.md) expression along with optional parameters
5-
to control time ranges, size, style, labels, etc. For a quick overview by example see
3+
The default response is a PNG image plotting data matching the
4+
[Atlas Stack Language](../../asl/tutorial.md) expression along with optional parameters
5+
to control time ranges, size, style, labels, etc. For a quick overview by example see
66
the [examples](examples.md) page.
77

8-
If graphs look familiar, that's because the design and language were inspired by
8+
If graphs look familiar, that's because the design and language were inspired by
99
[RRDtool](https://oss.oetiker.ch/rrdtool/). RRD style graphs offer concise and highly
1010
customizable views of time series data. While a number of observability tools offer
1111
dynamic charts, a major benefit of these PNG graphs is the ability to snapshot data
12-
in time, particularly when that data may expire from a high throughput data store;
13-
PNGs are forever. Additionally, the majority of email and on-call systems support
12+
in time, particularly when that data may expire from a high throughput data store;
13+
PNGs are forever. Additionally, the majority of email and on-call systems support
1414
images out of the box without having to worry about porting a dynamic graphing
1515
library to various browsers and clients.
1616

@@ -31,10 +31,10 @@ Additional Output formats, including JSON, can be found in [Outputs](outputs.md)
3131

3232
### Data
3333

34-
The only required query param is `q` which is the [query expression](../../asl/tutorial.md)
35-
used by the user to select and manipulate data. The simplest API query you can make is
34+
The only required query param is `q` which is the [query expression](../../asl/tutorial.md)
35+
used by the user to select and manipulate data. The simplest API query you can make is
3636
`/api/v1/graph?q=42`. This will produce a graph from Atlas with a straight line having a
37-
value of `42` for 3 hours[*](#defaults) with a legend including statistics for the query period.
37+
value of `42` for 3 hours[*](#defaults) with a legend including statistics for the query period.
3838

3939
All query params related to fetching data:
4040

@@ -43,7 +43,7 @@ All query params related to fetching data:
4343
| `q` | Query expression | must be specified by user | [expr](../../asl/tutorial.md) |
4444
| `step` | Step size for data | auto | [duration](../time-parameters.md#durations) |
4545

46-
!!! Warning
46+
!!! Warning
4747
In most cases users should not set `step` directly. The `step` parameter
4848
is deprecated.
4949

docs/api/graph/heatmap.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Atlas primarily supports visualizing data in line charts. As of 1.8, Atlas can also visualize
22
via heatmaps using the [`:heatmap`](../../api/graph/line-styles.md#heatmap) line style.
3-
The graph area is broken up into a series of cells and a count for each cell is incremented when
4-
a measurement falls within the cells boundaries. Colors or shades of colors then fill in cells
3+
The graph area is broken up into a series of cells and a count for each cell is incremented when
4+
a measurement falls within the cells boundaries. Colors or shades of colors then fill in cells
55
based on the final count.
66

77
## Percentiles
88

99
Heatmaps are particularly useful on top of [percentile](../../spectator/patterns/percentile-timer.md)
10-
metrics to analyze the entire measurement range.
10+
metrics to analyze the entire measurement range.
1111

1212
**Note** Using the [log linear](axis-scale.md#log-linear) scale will help to highlight clustered regions of measurements
1313
via `&scale=log-linear`. The example also uses data not available in the demo Atlas instance.
@@ -20,7 +20,7 @@ via `&scale=log-linear`. The example also uses data not available in the demo At
2020

2121
## Bounds
2222

23-
The `&heatmap_l=` and `&heatmap_u` parameters can be used to narrow the range of cells
23+
The `&heatmap_l=` and `&heatmap_u` parameters can be used to narrow the range of cells
2424
displayed in a heatmap. Heatmap bounds act on the _count_ of measurements in a cell and the
2525
palette colors or shades chosen. Depending on the bound limits, some cells may appear empty.
2626

@@ -32,7 +32,7 @@ With Bounds (`&heatmap_l=1.2&heatmap_u=1.3`): /api/v1/graph?e=2012-01-01T00:00&q
3232
## Palette
3333

3434
The palette used for filling heatmap cells can be changed via the `&heatmap_palette=` parameter.
35-
By default, a color is chosen from the global palette (based on whether the heatmap is the
35+
By default, a color is chosen from the global palette (based on whether the heatmap is the
3636
first or a later expression). A gradient is then applied to that color with a lighter gradient
3737
representing smaller cell counts and darker representing larger counts.
3838

@@ -58,7 +58,7 @@ For further information, see [Custom Color Palettes](color-palettes.md#custom).
5858

5959
### Order of Expressions
6060

61-
When overlaying expressions with a heatmap and using the default palette, the order of
61+
When overlaying expressions with a heatmap and using the default palette, the order of
6262
expressions determines the color gradient used for cells. For example, if the heatmap
6363
expression is second in the query, the second palette color will be used as the gradient:
6464

docs/api/graph/line-styles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ percentage chart for a group by:
9292
Since 1.8.
9393

9494
Plotting many time series with a heat map can be useful for identifying concentrations of
95-
measurements where individual lines may produce too much noise.
95+
measurements where individual lines may produce too much noise.
9696

9797
See [Heatmap](heatmap.md) for more details.
9898

docs/api/graph/multi-y.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ By default all axes will pick up [axis settings](../../asl/ref/axis.md) with no
3131
@@@
3232

3333
Bounds and other axis settings can be set per axis, e.g., this graph moves the constant line for
34-
`42` to a separate axis and sets the lower bound to `0` via the `&l.1=0` parameter. This would
34+
`42` to a separate axis and sets the lower bound to `0` via the `&l.1=0` parameter. This would
3535
work as well for `&u.1=100e3`. Append the index after the `l.` or `u.` :
3636

3737
@@@ atlas-uri

docs/api/graph/tick.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ way of doing that is to disable the Y-axis labels by setting the tick label mode
7575
In situations where a graph has very small changes in value that generate a significant number
7676
of digits per tick, ticks may be labeled with offsets in order to fit the labels in
7777
the layout. A base value is displayed at the bottom of the axis and positive
78-
or negative offsets from the base displayed next to the ticks.
78+
or negative offsets from the base displayed next to the ticks.
7979

8080
For example, if the amount of disk space used varies by 1 byte occasionally, the ticks
8181
will be labeled by in increments of `+1.0`.
@@ -88,6 +88,6 @@ will be labeled by in increments of `+1.0`.
8888
It is possible for queries spanning different data sources to display offset labels due
8989
to differing schemes used to encode floating point values.
9090

91-
If offsets are not desirable, try adjusting the y [axis bounds].
91+
If offsets are not desirable, try adjusting the y [axis bounds].
9292

9393
[axis bounds]: axis-bounds.md

docs/api/tags.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ Specifies the output format to use. The default is `json`.
2323

2424
### Limit (limit)
2525

26-
Maximum number of results to return before paging the response. If the response is paged
27-
a `x-nflx-atlas-next-offset` will be set to indicate the next offset. Pass the value with an
28-
[offset](#offset-offset) param to get the next part of the list. If the header is not present
26+
Maximum number of results to return before paging the response. If the response is paged
27+
a `x-nflx-atlas-next-offset` will be set to indicate the next offset. Pass the value with an
28+
[offset](#offset-offset) param to get the next part of the list. If the header is not present
2929
there is no more data.
3030

3131
### Offset (offset)
@@ -36,5 +36,5 @@ If the response is paged this param is used to indicate where the next request s
3636

3737
Query expression used to select a set of metrics and manipulate them for
3838
presentation in a graph. The query expression can use query
39-
and std commands described in the reference.
39+
and std commands described in the reference.
4040

0 commit comments

Comments
 (0)