-
Notifications
You must be signed in to change notification settings - Fork 158
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Document using actionset labels to extend logs
- Loading branch information
Showing
5 changed files
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,5 +7,6 @@ Tasks | |
|
||
tasks/argo.rst | ||
tasks/logs_level.rst | ||
tasks/logs_labels.rst | ||
tasks/logs.rst | ||
tasks/scaleworkload.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
Configuring logs for specific ActionSets | ||
---------------------------- | ||
|
||
Kanister uses structured logging to ensure that its logs can be easily | ||
categorized, indexed and searched by downstream log aggregation software. | ||
|
||
Extra fields can be added to log records for specific ActionSet. | ||
To do that the ActionSet needs to have a label with the ``kanister.io/`` prefix. | ||
|
||
For example: | ||
|
||
.. code-block:: yaml | ||
:linenos: | ||
apiVersion: cr.kanister.io/v1alpha1 | ||
kind: ActionSet | ||
metadata: | ||
namespace: kanister | ||
name: myActionSet | ||
labels: | ||
kanister.io/myFieldName: myFieldValue | ||
All logs concerning this ActionSet execution will have | ||
``myFieldName`` field with ``myFieldValue`` value. | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Configuring logs for specific ActionSets | ||
|
||
Kanister uses structured logging to ensure that its logs can be easily | ||
categorized, indexed and searched by downstream log aggregation software. | ||
|
||
Extra fields can be added to log records for specific ActionSet. | ||
To do that the ActionSet needs to have a label with the `kanister.io/` prefix. | ||
|
||
For example: | ||
|
||
``` yaml | ||
apiVersion: cr.kanister.io/v1alpha1 | ||
kind: ActionSet | ||
metadata: | ||
namespace: kanister | ||
name: myActionSet | ||
labels: | ||
kanister.io/myFieldName: myFieldValue | ||
|
||
``` | ||
|
||
All logs concerning this ActionSet execution will have | ||
`myFieldName` field with `myFieldValue` value. |