You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/user-guide/quick-start/clp-text/main-page.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
-
# CLP-text
1
+
# clp-text Quick-start
2
2
3
-
This page will walk you through how to start up CLP, and also show you how to use CLP to compress and search unstructured text logs.
3
+
This page will walk you through how to start up CLP, and then use it to compress and search unstructured text logs.
4
4
5
5
:::{caution}
6
-
If you're using the `clp-text` release, you should only compress unstructured text logs. `clp-text`can compress and search JSON logs as if it was unstructured text, but `clp-text` cannot query individual fields. This limitation will be addressed in a future version of CLP.
6
+
If you're using the `clp-text` release, you should only compress unstructured text logs. `clp-text`is able to compress and search JSON logs as if it was unstructured text, but `clp-text` cannot query individual fields. This limitation will be addressed in a future version of CLP.
7
7
:::
8
8
9
9
---
@@ -37,7 +37,7 @@ Compressed logs will be stored in the `/var/bin/archives` directory.
37
37
38
38
### Sample logs
39
39
40
-
For some sample logs, check out the open-source [datasets](../../resources/resources-datasets.md).
40
+
For some sample logs, check out the open-source [datasets](../../resources/resources-datasets).
41
41
42
42
### Examining compression statistics
43
43
@@ -54,13 +54,13 @@ You can search through your logs using queries from the UI or from the command l
54
54
55
55
Regardless of what method you use to search, you'll need a query to find the logs you're looking for. All unstructured text log queries are written as plain text.
56
56
57
-
You can use a couple special characters to make these queries more versatile. `*` can be used as a placeholder for an unknown number of characters, and `?` can be used for a single character. For example, the query
57
+
You can use a couple of special characters to make these queries more versatile. `*` can be used as a placeholder for an unknown number of characters, and `?` can be used for a single character. For example, the query
58
58
59
-
```bash
60
-
one * two?three
59
+
```bash
60
+
a*b?c
61
61
```
62
62
63
-
would return all logs that contain the sequence of characters "one" followed by any number (even zero) of other characters, followed by "two", followed by one other character, followed by "three".
63
+
would return all logs that contain the character `"a"` followed by any number (including zero) of other characters, followed by `"b"`, followed by one other character, followed by `"c"`.
64
64
65
65
There are a number of other syntax rules specific to unstructured text queries that you can use to make your searches more powerful and effective. You can read about these syntax rules [here](../../reference/reference-text-search-syntax).
66
66
@@ -125,4 +125,4 @@ sbin/stop-clp.sh
125
125
126
126
## More information
127
127
128
-
You've reached the end of the clp-text quickstart guide. For more information on clp-text, visit the [CLP for unstructured logs](../../core/core-unstructured/index) page.
128
+
You've reached the end of the clp-text quick-start guide. For more information on clp-text, visit the [CLP for unstructured logs](../../core/core-unstructured/index) page.
Copy file name to clipboardExpand all lines: docs/src/user-guide/quick-start/setup/main-page.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ To run properly on your system, CLP requires a few other programs. Before you se
12
12
13
13
CLP uses Docker to deploy its different components. You can check whether Docker is already installed on your system by running the command
14
14
15
-
```bash
15
+
```bash
16
16
docker version
17
17
```
18
18
@@ -26,11 +26,11 @@ If you're using Docker Desktop, ensure version 4.34 or higher is installed, and
26
26
27
27
CLP uses Python to interpret the scripts that coordinate how it runs. Specifically, CLP needs Python version 3.8 or higher. Many Linux distributions come with Python pre-installed, but just to be sure, run the command
28
28
29
-
```bash
29
+
```bash
30
30
python3 --version
31
31
```
32
32
33
-
If Python isn't on your system, or if the version isn't high enough, follow the instructions [here][Python] to install or upgrade it.
33
+
If Python isn't on your system, or if the version isn't high enough, install or upgrade it.
34
34
35
35
:::{note}
36
36
If you're planning on deploying CLP on multiple nodes/systems, there are a few other system requirements; check out the [multi-node deployment](../../guides/guides-multi-node/multi-node) page for more details.
@@ -74,7 +74,7 @@ object. For example:
74
74
The log file above contains two log events represented by two JSON objects printed one after the
75
75
other. Whitespace is ignored, so the log events could also appear with no newlines and indentation.
76
76
77
-
If your logs are JSON logs, download and extract the JSON flavour tarball from the [Releases][clp-releases] page on GitHub, and proceed to the CLP-JSON portal below.
77
+
If your logs are JSON logs, download and extract the JSON flavour tarball from the [Releases][clp-releases] page on GitHub, and proceed to the clp-json portal below.
78
78
79
79
::::{grid} 1 1 1 1
80
80
:gutter: 2
@@ -83,7 +83,7 @@ If your logs are JSON logs, download and extract the JSON flavour tarball from t
83
83
:link: ../clp-json/main-page
84
84
CLP for JSON logs
85
85
^^^
86
-
Learn how to start up CLP-JSON, and begin compressing and searching JSON logs.
86
+
Learn how to start up clp-json, and begin compressing and searching JSON logs.
The log file above contains two log events, both beginning with a timestamp. The first is a single
113
113
line while the second contains multiple lines.
114
114
115
-
If your logs are unstructured text logs, download and extract the unstructured text flavour tarball from the [Releases][clp-releases] page on GitHub, and proceed to the CLP-text portal below.
115
+
If your logs are unstructured text logs, download and extract the unstructured text flavour tarball from the [Releases][clp-releases] page on GitHub, and proceed to the clp-text portal below.
116
116
117
117
::::{grid} 1 1 1 1
118
118
:gutter: 2
@@ -121,12 +121,11 @@ If your logs are unstructured text logs, download and extract the unstructured t
121
121
:link: ../clp-text/main-page
122
122
CLP for unstructured logs
123
123
^^^
124
-
Learn how to start up CLP-text, and begin compressing and searching unstructured text logs.
124
+
Learn how to start up clp-text, and begin compressing and searching unstructured text logs.
0 commit comments