siglens-docs/sidebars.js at develop · siglens/siglens-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
/**
 * Creating a sidebar enables you to:
 - create an ordered group of docs
 - render a sidebar for each doc of that group
 - provide next/previous navigation

 The sidebars can be generated from the filesystem, or explicitly defined here.

 Create as many sidebars as you want.
 */

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
  docsSidebar: [
    'introduction',
    'key-concepts',
    {
      type: 'category',
      label: 'Installation',
      link: {
        type: 'generated-index',
      },
      items: ['installation/docker', 'installation/helm', 'installation/git'],
    },
    {
      type: 'category',
      label: 'Log Ingestion',
      link: {
        type: 'generated-index',
        description:
          'SigLens default ingestion server runs on port: 8081. The below are the various ways to ingest logs into SigLens.',
      },
      items: [
        'log-ingestion/vector',
        'log-ingestion/logstash',
        'log-ingestion/fluentd',
        'log-ingestion/fluent-bit',
        'log-ingestion/filebeat',
        'log-ingestion/promtail',
        'log-ingestion/open-telemetry',
      ],
    },
    {
      type: 'category',
      label: 'Metric Ingestion',
      link: {
        type: 'generated-index',
      },
      items: [
        'metric-ingestion/vector-metrics',
        'metric-ingestion/open-telemetry',
      ],
    },
    {
      type: 'category',
      label: 'Instrumentation for Traces',
      link: {
        type: 'generated-index',
      },
      items: [
        'instrument-traces/go-app',
        'instrument-traces/java-app',
        'instrument-traces/python-app',
        'instrument-traces/dotnet-app',
        'instrument-traces/js-app',
      ],
    },
    {
      type: 'category',
      label: 'Migration',
      link: {
        type: 'generated-index',
      },
      items: [
        {
          type: 'category',
          label: 'Migrating from Splunk',
          link: {
            type: 'generated-index',
            title: 'Migrating from Splunk',
            description: `Migrating from Splunk to SigLens is a simple process. Please follow the below steps to migrate from Splunk to SigLens.`,
          },
          items: [
            'migration/splunk/vector',
            'migration/splunk/logstash',
            'migration/splunk/fluentd',
          ],
        },
        {
          type: 'category',
          label: 'Migrating from Elastic Search',
          link: {
            type: 'generated-index',
            title: 'Migrating from Elastic Search',
            description: `Migrating from Elastic Search to SigLens is a simple process. Please follow the below steps to migrate from Elastic Search to SigLens.`,
          },
          items: [
            'migration/elasticsearch/vector',
            'migration/elasticsearch/logstash',
            'migration/elasticsearch/fluentd',
          ],
        },
        {
          type: 'category',
          label: 'Migrating from Loki',
          link: {
            type: 'generated-index',
            title: 'Migrating from Loki',
            description: `Migrating from Loki to SigLens is a simple process. Please follow the below steps to migrate from Loki to SigLens.`,
          },
          items: ['migration/loki/promtail'],
        },
        {
          type: 'category',
          label: 'Migrating from Google Cloud',
          link: {
            type: 'generated-index',
            title: 'Migrating from Google Cloud',
            description: `Migrating from Google Cloud to SigLens is a simple process. Please follow the below steps to migrate from Loki to SigLens.`,
          },
          items: ['migration/gcloud/vector'],
        },
        {
          type: 'category',
          label: 'Migrating from AWS CloudWatch',
          link: {
            type: 'generated-index',
            title: 'Migrating from AWS CloudWatch',
            description: `Migrating/Streaming Logs from AWS CloudWatch to SigLens is a simple process. Please follow the below steps to migrate to SigLens.`,
          },
          items: [
            'migration/awscloudwatch/aws-lambda',
            'migration/awscloudwatch/fluentd',
          ],
        },
        {
          type: 'category',
          label: 'Migrating from Datadog',
          link: {
            type: 'generated-index',
            title: 'Migrating from Datadog',
            description: `Migrating from Datadog to SigLens is a simple process. Please follow the below steps to migrate from Datadog to SigLens.`,
          },
          items: ['migration/datadog/vector'],
        },
      ],
    },
    {
      type: 'category',
      label: 'Splunk Commands',
      link: {
        type: 'generated-index',
      },
      items: [
        'spl-docs/splunk-commands',
        'spl-docs/common-usecases',
        'spl-docs/bin-command',
        'spl-docs/dedup-command',
        'spl-docs/eval-command',
        'spl-docs/extract-command',
        'spl-docs/fields-command',
        'spl-docs/fillnull-command',
        'spl-docs/format-command',
        'spl-docs/gentimes-command',
        'spl-docs/head-command',
        'spl-docs/inputlookup-command',
        'spl-docs/makemv-command',
        'spl-docs/mvexpand-command',
        'spl-docs/rare-command',
        'spl-docs/regex-command',
        'spl-docs/rename-command',
        'spl-docs/rex-command',
        'spl-docs/search-command',
        'spl-docs/sort-command',
        'spl-docs/stats-command',
        'spl-docs/streamstats-command',
        'spl-docs/tail-command',
        'spl-docs/timechart-command',
        'spl-docs/tojson-command',
        'spl-docs/top-command',
        'spl-docs/transaction-command',
        'spl-docs/where-command',
        'spl-docs/time-modifiers',
        {
          type: 'category',
          label: 'Evaluation Functions',
          link: {
            type: 'generated-index',
            title: 'Evaluation Functions',
            description: `Use evaluation functions to evaluate an expression on your events`,
          },
          items: [
            'spl-docs/evaluation-functions/overview',
            'spl-docs/evaluation-functions/comparison-conditional-functions',
            'spl-docs/evaluation-functions/conversion-functions',
            'spl-docs/evaluation-functions/informational-functions',
            'spl-docs/evaluation-functions/mathematical-functions',
            'spl-docs/evaluation-functions/multivalue-functions',
            'spl-docs/evaluation-functions/statistical-functions',
            'spl-docs/evaluation-functions/text-functions',
            'spl-docs/evaluation-functions/trig-hyperbolic-functions',
            'spl-docs/evaluation-functions/time-functions',
            'spl-docs/evaluation-functions/time-variables',
          ],
        },
        {
          type: 'category',
          label: 'Aggregate Functions',
          link: {
            type: 'generated-index',
            title: 'Aggregate Functions',
            description: `Use stats functions to perform statistical calculations over your events`,
          },
          items: ['spl-docs/aggregate-functions/agg-functions'],
        },
      ],
    },
    {
      type: 'category',
      label: 'Grafana Integrations',
      items: ['grafana-integrations/prometheus-data-source'],
    },
    'splunk-apis',
    'promql-apis',
    'siglens-metrics',
    'searching-logs',
    'log-query-builder',
    'dashboards',
    'saved-searches',
    'alerts',
    'cluster-health',
    'retention',
    'configuration',
    'oss-vs-enterprise-features',
    'contribution-guidelines',
    'community',
  ],
};

export default sidebars;