Skip to content

Commit aec9a42

Browse files
author
Rashid Khan
committed
Skeleton API docs
1 parent e95503f commit aec9a42

31 files changed

+1231
-252
lines changed

‎Gruntfile.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ module.exports = function (grunt) {
88
srcDir: 'src',
99
destDir: 'dist',
1010
tempDir: 'tmp',
11-
docsDir: 'docs'
11+
docsDir: 'docs/'
1212
};
1313

1414
// load plugins

‎docs/configuration/config.js.asciidoc renamed to ‎docs/kibana/configuration/config.js.asciidoc

+4-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
1-
2-
= Kibana =
3-
41
== Configuration ==
52
config.js is where you will find the core Kibana configuration. This file contains parameter that
63
must be set before kibana is run for the first time.
74
// src/config.js:1
85

96
=== Parameters ===
10-
// src/config.js:13
7+
// src/config.js:10
118

129
==== elasticsearch ====
1310

@@ -16,17 +13,17 @@ want +http://localhost:9200+ here. Even if Kibana and Elasticsearch are on
1613
the same host. By default this will attempt to reach ES at the same host you have
1714
elasticsearch installed on. You probably want to set it to the FQDN of your
1815
elasticsearch host
19-
// src/config.js:18
16+
// src/config.js:15
2017

2118
==== kibana-int ====
2219

2320
The default ES index to use for storing Kibana specific object
2421
such as stored dashboards
25-
// src/config.js:29
22+
// src/config.js:26
2623

2724
==== panel_name ====
2825

2926
An array of panel modules available. Panels will only be loaded when they are defined in the
3027
dashboard, but this list is used in the "add panel" interface.
31-
// src/config.js:37
28+
// src/config.js:34
3229

‎docs/kibana/index.asciidoc

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
= Kibana
2+
3+
// Why can't I have a preamble here?
4+
5+
== Introduction
6+
7+
Kibana is an open source (Apache Licensed), browser based analytics and search dashboard for
8+
ElasticSearch. Kibana is a snap to setup and start using. Written entirely in HTML and Javascript
9+
it requires only a plain webserver, Kibana requires no fancy server side components.
10+
Kibana strives to be easy to get started with, while also being flexible and powerful, just like
11+
Elasticsearch.
12+
13+
include::configuration/config.js.asciidoc[]
14+
15+
include::panels.asciidoc[]
16+
17+
// src/app/controllers/dash.js:1
18+

‎docs/kibana/panels.asciidoc

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
[[panels]]
2+
= Panels
3+
4+
[partintro]
5+
--
6+
*Kibana* dashboards are made up of blocks called +panels+. Panels are organized into rows
7+
and can serve many purposes, though most are designed to provide the results of a query or
8+
multiple queries as a visualization. Other panels may show collections of documents or
9+
allow you to insert instructions for your users.
10+
11+
Panels can be configured easily via the Kibana web interface. For more advanced usage, such
12+
as templated or scripted dashboards, documentation of panel properties is available in this
13+
section. You may find settings here which are not exposed via the web interface.
14+
15+
Each panel type has its own properties, hover there are several that are shared.
16+
17+
// src/app/controllers/row.js:61
18+
19+
span:: A number, 1-12, that describes the width of the panel.
20+
// src/app/controllers/row.js:87
21+
22+
editable:: Enable or disable the edit button the the panel
23+
// src/app/controllers/row.js:91
24+
25+
type:: The type of panel this object contains. Each panel type will require additional
26+
properties. See the panel types list to the right.
27+
// src/app/controllers/row.js:95
28+
29+
--
30+
// src/app/controllers/row.js:103
31+
32+
include::panels/bettermap.asciidoc[]
33+
// src/app/panels/bettermap/module.js:1
34+
35+
include::panels/column.asciidoc[]
36+
// src/app/panels/column/module.js:1
37+
38+
include::panels/histogram.asciidoc[]
39+
// src/app/panels/histogram/module.js:1
40+
41+
include::panels/hits.asciidoc[]
42+
// src/app/panels/hits/module.js:1
43+
44+
include::panels/map.asciidoc[]
45+
// src/app/panels/map/module.js:1
46+
47+
include::panels/pie.asciidoc[]
48+
// src/app/panels/pie/module.js:1
49+
50+
include::panels/sparklines.asciidoc[]
51+
// src/app/panels/sparklines/module.js:1
52+
53+
include::panels/table.asciidoc[]
54+
// src/app/panels/table/module.js:1
55+
56+
include::panels/terms.asciidoc[]
57+
// src/app/panels/terms/module.js:1
58+
59+
include::panels/text.asciidoc[]
60+
// src/app/panels/text/module.js:1
61+
62+
include::panels/trends.asciidoc[]
63+
// src/app/panels/trends/module.js:1
64+

‎docs/kibana/panels/bettermap.asciidoc

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
== Bettermap
2+
Status: *Experimental*
3+
4+
Bettermap is called bettermap for lack of a better name. Bettermap uses geographic coordinates to
5+
create clusters of markers on map and shade them orange, yellow and green depending on the
6+
density of the cluster.
7+
8+
To drill down, click on a cluster. The map will be zoomed and the cluster broken into smaller cluster.
9+
When it no longer makes visual sense to cluster, individual markers will be displayed. Hover over
10+
a marker to see the tooltip value/
11+
12+
IMPORTANT: bettermap requires an internet connection to download its map panels.
13+
// src/app/panels/bettermap/module.js:5
14+
15+
=== Parameters
16+
17+
field:: The field that contains the coordinates, in geojson format. GeoJSON is
18+
+[longitude,latitude]+ in an array. This is different from most implementations, which use
19+
latitude, longitude.
20+
// src/app/panels/bettermap/module.js:62
21+
22+
size:: The number of documents to use when drawing the map
23+
// src/app/panels/bettermap/module.js:70
24+
25+
spyable:: Should the `inspect` icon be shown?
26+
// src/app/panels/bettermap/module.js:74
27+
28+
tooltip:: Which field to use for the tooltip when hovering over a marker
29+
// src/app/panels/bettermap/module.js:78
30+
31+
==== Queries
32+
queries object:: This object describes the queries to use on this panel.
33+
queries.mode::: Of the queries available, which to use. Options: +all, pinned, unpinned, selected+
34+
queries.ids::: In +selected+ mode, which query ids are selected.
35+
// src/app/panels/bettermap/module.js:82
36+

‎docs/kibana/panels/column.asciidoc

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
== Column
2+
Status: *Stable*
3+
4+
A pseudo panel that lets you add other panels to be arranged in a column with defined heights.
5+
While the column panel is stable, it does have many limitations, including the inability to drag
6+
and drop panels within its borders. It may be removed in a future release.
7+
8+
// src/app/panels/column/module.js:5
9+
10+
=== Parameters
11+
12+
panel:: An array of panel objects
13+
// src/app/panels/column/module.js:36
14+

‎docs/kibana/panels/histogram.asciidoc

+129
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
== Histogram
2+
Status: *Stable*
3+
4+
The histogram panel allow for the display of time charts. It includes several modes and tranformations
5+
to display event counts, mean, min, max and total of numeric fields, and derivatives of counter
6+
fields.
7+
8+
// src/app/panels/histogram/module.js:5
9+
10+
=== Parameters
11+
==== Axis options
12+
mode:: Value to use for the y-axis. For all modes other than count, +value_field+ must be
13+
defined. Possible values: count, mean, max, min, total.
14+
// src/app/panels/histogram/module.js:65
15+
16+
time_field:: x-axis field. This must be defined as a date type in Elasticsearch.
17+
// src/app/panels/histogram/module.js:72
18+
19+
value_field:: y-axis field if +mode+ is set to mean, max, min or total. Must be numeric.
20+
// src/app/panels/histogram/module.js:76
21+
22+
x-axis:: Show the x-axis
23+
// src/app/panels/histogram/module.js:80
24+
25+
y-axis:: Show the y-axis
26+
// src/app/panels/histogram/module.js:84
27+
28+
scale:: Scale the y-axis by this factor
29+
// src/app/panels/histogram/module.js:88
30+
31+
y_as_bytes:: Show the y-axis scale as bytes, automatically round to KB, MB, GB, etc.
32+
// src/app/panels/histogram/module.js:92
33+
34+
==== Annotations
35+
annotate object:: A query can be specified, the results of which will be displayed as markers on
36+
the chart. For example, for noting code deploys.
37+
annotate.enable::: Should annotations, aka markers, be shown?
38+
annotate.query::: Lucene query_string syntax query to use for markers.
39+
annotate.size::: Max number of markers to show
40+
annotate.field::: Field from documents to show
41+
annotate.sort::: Sort array in format [field,order], For example [`@timestamp',`desc']
42+
// src/app/panels/histogram/module.js:115
43+
44+
==== Interval options
45+
auto_int:: Automatically scale intervals?
46+
// src/app/panels/histogram/module.js:132
47+
48+
resolution:: If auto_int is true, shoot for this many bars.
49+
// src/app/panels/histogram/module.js:137
50+
51+
interval:: If auto_int is set to false, use this as the interval.
52+
// src/app/panels/histogram/module.js:141
53+
54+
interval:: Array of possible intervals in the *View* selector. Example [`auto',`1s',`5m',`3h']
55+
// src/app/panels/histogram/module.js:145
56+
57+
==== Drawing options
58+
lines:: Show line chart
59+
// src/app/panels/histogram/module.js:149
60+
61+
fill:: Area fill factor for line charts, 1-10
62+
// src/app/panels/histogram/module.js:154
63+
64+
linewidth:: Weight of lines in pixels
65+
// src/app/panels/histogram/module.js:158
66+
67+
points:: Show points on chart
68+
// src/app/panels/histogram/module.js:162
69+
70+
pointradius:: Size of points in pixels
71+
// src/app/panels/histogram/module.js:166
72+
73+
bars:: Show bars on chart
74+
// src/app/panels/histogram/module.js:170
75+
76+
stack:: Stack multiple series
77+
// src/app/panels/histogram/module.js:174
78+
79+
spyable:: Show inspect icon
80+
// src/app/panels/histogram/module.js:178
81+
82+
zoomlinks:: Show `Zoom Out' link
83+
// src/app/panels/histogram/module.js:182
84+
85+
options:: Show quick view options section
86+
// src/app/panels/histogram/module.js:186
87+
88+
legend:: Display the legond
89+
// src/app/panels/histogram/module.js:190
90+
91+
show_query:: If no alias is set, should the query be displayed?
92+
// src/app/panels/histogram/module.js:194
93+
94+
interactive:: Enable click-and-drag to zoom functionality
95+
// src/app/panels/histogram/module.js:198
96+
97+
legend_counts:: Show counts in legend
98+
// src/app/panels/histogram/module.js:202
99+
100+
==== Transformations
101+
timezone:: Correct for browser timezone?. Valid values: browser, utc
102+
// src/app/panels/histogram/module.js:206
103+
104+
percentage:: Show the y-axis as a percentage of the axis total. Only makes sense for multiple
105+
queries
106+
// src/app/panels/histogram/module.js:211
107+
108+
zerofill:: Improves the accuracy of line charts at a small performance cost.
109+
// src/app/panels/histogram/module.js:216
110+
111+
derivative:: Show each point on the x-axis as the change from the previous point
112+
// src/app/panels/histogram/module.js:220
113+
114+
tooltip object::
115+
tooltip.value_type::: Individual or cumulative controls how tooltips are display on stacked charts
116+
tooltip.query_as_alias::: If no alias is set, should the query be displayed?
117+
// src/app/panels/histogram/module.js:224
118+
119+
grid object:: Min and max y-axis values
120+
grid.min::: Minimum y-axis value
121+
grid.max::: Maximum y-axis value
122+
// src/app/panels/histogram/module.js:96
123+
124+
==== Queries
125+
queries object:: This object describes the queries to use on this panel.
126+
queries.mode::: Of the queries available, which to use. Options: +all, pinned, unpinned, selected+
127+
queries.ids::: In +selected+ mode, which query ids are selected.
128+
// src/app/panels/histogram/module.js:105
129+

‎docs/kibana/panels/hits.asciidoc

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
== Hits
2+
Status: *Stable*
3+
4+
The hits panel displays the number of hits for each of the queries on the dashboard in a
5+
configurable format specified by the `chart' property.
6+
7+
// src/app/panels/hits/module.js:5
8+
9+
=== Parameters
10+
11+
arrangement:: The arrangement of the legend. horizontal or vertical
12+
// src/app/panels/hits/module.js:49
13+
14+
chart:: bar, pie or none
15+
// src/app/panels/hits/module.js:55
16+
17+
counter_pos:: The position of the legend, above or below
18+
// src/app/panels/hits/module.js:59
19+
20+
donut:: If the chart is set to pie, setting donut to true will draw a hole in the midle of it
21+
// src/app/panels/hits/module.js:63
22+
23+
tilt:: If the chart is set to pie, setting tilt to true will tilt it back into an oval
24+
// src/app/panels/hits/module.js:67
25+
26+
labels:: If the chart is set to pie, setting labels to true will draw labels in the slices
27+
// src/app/panels/hits/module.js:71
28+
29+
spyable:: Setting spyable to false disables the inspect icon.
30+
// src/app/panels/hits/module.js:75
31+
32+
==== Queries
33+
queries object:: This object describes the queries to use on this panel.
34+
queries.mode::: Of the queries available, which to use. Options: +all, pinned, unpinned, selected+
35+
queries.ids::: In +selected+ mode, which query ids are selected.
36+
// src/app/panels/hits/module.js:79
37+

‎docs/kibana/panels/map.asciidoc

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
== Map
2+
Status: *Stable*
3+
4+
The map panel translates 2 letter country or state codes into shaded regions on a map. Currently
5+
available maps are world, usa and europe.
6+
7+
// src/app/panels/map/module.js:5
8+
9+
=== Parameters
10+
11+
map:: Map to display. world, usa, europe
12+
// src/app/panels/map/module.js:48
13+
14+
colors:: An array of colors to use to shade the map. If 2 colors are specified, shades
15+
between them will be used. For example [`#A0E2E2', `#265656']
16+
// src/app/panels/map/module.js:54
17+
18+
size:: Max number of regions to shade
19+
// src/app/panels/map/module.js:59
20+
21+
exclude:: exclude this array of regions. For example [`US',`BR',`IN']
22+
// src/app/panels/map/module.js:63
23+
24+
spyable:: Setting spyable to false disables the inspect icon.
25+
// src/app/panels/map/module.js:67
26+
27+
==== Queries
28+
queries object:: This object describes the queries to use on this panel.
29+
queries.mode::: Of the queries available, which to use. Options: +all, pinned, unpinned, selected+
30+
queries.ids::: In +selected+ mode, which query ids are selected.
31+
// src/app/panels/map/module.js:71
32+

0 commit comments

Comments
 (0)