Skip to content

Commit 5376cc2

Browse files
committed
Update README, remove unnecesarry parameters
1 parent 4f0a71f commit 5376cc2

File tree

4 files changed

+23
-29
lines changed

4 files changed

+23
-29
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ You should see an entry named "my-release" (or the release name you chose) with
179179

180180
## Configuration Options
181181

182-
This section describes the configuration options you can use with Helm. 
182+
This section describes the configuration options you can use with Helm.
183183

184184
### --values
185185

@@ -221,6 +221,14 @@ helm install my-release marklogic/marklogic --version=1.0.0-ea1 \
221221

222222
We recommend that you use the `values.yaml` file for configuring your installation.
223223

224+
### Logging
225+
226+
To enable log collection for all Marklogic logs set logging.enabled to true. Set each option in logging.trackFiles to true of false depending on if you want to track each type of Marklogic log file.
227+
228+
In order to use the logs that are colleceted you must define an output in the configmap.yaml file. Fluent Bit will parse and output all the log files from each pod to the output you set.
229+
230+
For documentation on how to setup the Fluent Bit output with your logging backend see Fluent Bit's output documentation here: <https://docs.fluentbit.io/manual/pipeline/outputs>
231+
224232
# Access the MarkLogic Server
225233

226234
## Service
@@ -369,3 +377,9 @@ This table describes the list of available parameters for Helm Chart.
369377
| `startupProbe.timeoutSeconds` | Timeout seconds for startup probe | `1` |
370378
| `startupProbe.failureThreshold` | Failure threshold for startup probe | `30` |
371379
| `startupProbe.successThreshold` | Success threshold for startup probe | `1` |
380+
| `logging.enabled` | Enable this parameter to enable cluster wide log collection of Marklogic server logs | `false` |
381+
| `logging.trackFiles.errorLogs` | Enable this parameter to enable collection of Marklogics error logs when cluster level logging is enabled | `true` |
382+
| `logging.trackFiles.accessLogs` | Enable this parameter to enable collection of Marklogics access logs when cluster level logging is enabled | `true` |
383+
| `logging.trackFiles.requestLogs` | Enable this parameter to enable collection of Marklogics request logs when cluster level logging is enabled | `true` |
384+
| `logging.trackFiles.crashLogs` | Enable this parameter to enable collection of Marklogics crash logs when cluster level logging is enabled | `true` |
385+
| `logging.trackFiles.auditLogs` | Enable this parameter to enable collection of Marklogics audit logs when cluster level logging is enabled | `true` |

charts/templates/configmap.yaml

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ data:
1414
apiVersion: v1
1515
kind: ConfigMap
1616
metadata:
17-
name: {{ .Values.logging.configMapName }}
17+
name: {{ include "marklogic.fullname" . }}-fb-config-map
1818
namespace: {{ .Release.Namespace }}
1919
data:
2020
fluent-bit.conf: |
@@ -36,6 +36,7 @@ data:
3636
Read_from_head true
3737
Tag kube.marklogic.logs.error
3838
Path_Key path
39+
Parser error_parser
3940
{{- end }}
4041
4142
{{- if .Values.logging.trackFiles.accessLogs }}
@@ -45,6 +46,7 @@ data:
4546
Read_from_head true
4647
tag kube.marklogic.logs.access
4748
Path_Key path
49+
Parser access_parser
4850
{{- end }}
4951
5052
{{- if .Values.logging.trackFiles.requestLogs }}
@@ -54,6 +56,7 @@ data:
5456
Read_from_head true
5557
tag kube.marklogic.logs.request
5658
Path_Key path
59+
Parser json_parser
5760
{{- end }}
5861
5962
{{- if .Values.logging.trackFiles.crashLogs }}
@@ -119,28 +122,6 @@ data:
119122
Match kube.marklogic.logs.crash
120123
Add tag kube.marklogic.logs.crash
121124
122-
# Parse Logs
123-
[FILTER]
124-
Name parser
125-
Match kube.marklogic.logs.error
126-
Key_Name log
127-
Parser error_parser
128-
Reserve_Data On
129-
130-
[FILTER]
131-
Name parser
132-
Match kube.marklogic.logs.access
133-
Key_Name log
134-
Parser access_parser
135-
Reserve_Data On
136-
137-
[FILTER]
138-
Name parser
139-
Match kube.marklogic.logs.request
140-
Key_Name log
141-
Parser json_parser
142-
Reserve_Data On
143-
144125
parsers.conf: |
145126
[PARSER]
146127
Name error_parser

charts/templates/statefulset.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ spec:
154154
{{- if .Values.extraVolumeMounts }}
155155
{{- toYaml .Values.extraVolumeMounts | nindent 12 }}
156156
{{- end }}
157-
- name: {{ .Values.logging.configMapName }}
157+
- name: {{ include "marklogic.fullname" . }}-fb-config-map
158158
mountPath: /fluent-bit/etc/
159159
env:
160160
- name: POD_NAME
@@ -174,9 +174,9 @@ spec:
174174
{{- end }}
175175
volumes:
176176
{{- if .Values.logging.enabled }}
177-
- name: {{ .Values.logging.configMapName }}
177+
- name: {{ include "marklogic.fullname" . }}-fb-config-map
178178
configMap:
179-
name: {{ .Values.logging.configMapName }}
179+
name: {{ include "marklogic.fullname" . }}-fb-config-map
180180
{{- end }}
181181
{{- if or (not .Values.persistence.enabled) (.Values.extraVolumes) }}
182182
{{- if not .Values.persistence.enabled }}

charts/values.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,7 @@ startupProbe:
118118
successThreshold: 1
119119

120120
logging:
121-
enabled: true
122-
configMapName: fluent-bit-config
121+
enabled: false
123122
trackFiles:
124123
errorLogs: true
125124
accessLogs: true

0 commit comments

Comments
 (0)