Merge pull request #572 from snyk/feat/control-log-level-verbosity

feat: control log level verbosity

Author: dkontorovskyy

README.md

@@ -140,6 +140,14 @@ no_proxy: *.example.local,*.other.global,192.168.0.0/16
 no_proxy: long.domain.name.local,example.local
 ```
 
+## Changing log level ##
+
+To lower `snyk-monitor`'s logging verbosity `log_level` value could be set to one of these options:
+* `'WARN'`
+* `'ERROR'`
+
+By default, `log_level` is `'INFO'`.
+
 ## Terms and conditions ##
 
 *The Snyk Container Kubernetes integration uses Red Hat UBI (Universal Base Image).*

snyk-monitor-deployment.yaml

@@ -80,6 +80,8 @@ spec:
                 name: snyk-monitor
                 key: no_proxy
                 optional: true
+          - name: LOG_LEVEL
+            value: 'INFO'
         resources:
           requests:
             cpu: '250m'

snyk-monitor/README.md

@@ -126,6 +126,22 @@ helm upgrade --install ... \
   --set no_proxy=long.domain.name.local,example.local
 ```
 
+## Changing log level ##
+
+To lower `snyk-monitor`'s logging verbosity `log_level` value could be set to one of these options:
+* `'WARN'`
+* `'ERROR'`
+
+By default, `log_level` is `'INFO'`.
+
+For example
+```bash
+helm upgrade --install snyk-monitor snyk-charts/snyk-monitor \
+  --namespace snyk-monitor \
+  --set clusterName="Production cluster" \
+  --set log_level="WARN"
+```
+
 ## PodSecurityPolicies
 **This should not be used when installing on OpenShift.**
 

snyk-monitor/templates/deployment.yaml

@@ -58,6 +58,8 @@ spec:
             value: {{ .Values.https_proxy }}
           - name: NO_PROXY
             value: {{ .Values.no_proxy }}
+          - name: LOG_LEVEL
+            value: {{ .Values.log_level }}
           resources:
             requests:
               cpu: {{ .Values.requests.cpu }}

snyk-monitor/values.yaml

@@ -44,6 +44,9 @@ http_proxy:
 https_proxy:
 no_proxy:
 
+# Override default (INFO) log level if less verbosity needed
+log_level:
+
 nodeSelector: {}
 
 psp:

src/common/logger.ts

@@ -1,6 +1,13 @@
 import * as bunyan from 'bunyan';
 import config = require('./config');
 
+try {
+  // Validate if LOG_LEVEL has valid bunyan logging level
+  config.LOGGING.level = bunyan.resolveLevel(process.env.LOG_LEVEL || config.LOGGING.level);
+} catch(e) {
+  console.error(`Log level "${process.env.LOG_LEVEL}" is not valid logging level. Falling back to "INFO"`);
+}
+
 const logger: bunyan = bunyan.createLogger({
   name: config.LOGGING.name,
   level: config.LOGGING.level,

test/integration/kubernetes.test.ts

@@ -340,7 +340,7 @@ tap.test('snyk-monitor sends deleted workload to kubernetes-upstream', async (t)
   t.ok(deleteTestResult, 'snyk-monitor sent deleted workload data to kubernetes-upstream in the expected timeframe');
 });
 
-tap.test(`snyk-monitor has resource limits`, async (t) => {
+tap.test('snyk-monitor has resource limits', async (t) => {
   t.plan(5);
   const snykMonitorDeployment = await kubectl.getDeploymentJson('snyk-monitor', namespace);
   const monitorResources = snykMonitorDeployment.spec.template.spec.containers[0].resources;
@@ -352,6 +352,19 @@ tap.test(`snyk-monitor has resource limits`, async (t) => {
   t.ok(monitorResources.requests.memory !== undefined, 'snyk-monitor has memory resource request');
 });
 
+tap.test('snyk-monitor has log level', async(t) => {
+  if (['Helm', 'YAML'].includes(process.env.DEPLOYMENT_TYPE || '')) {
+    t.pass('Not testing LOG_LEVEL existence because we\'re not installing with Helm');
+    return;
+  }
+
+  const snykMonitorDeployment = await kubectl.getDeploymentJson('snyk-monitor', namespace);
+  const { LOG_LEVEL } = snykMonitorDeployment.spec.template.spec.containers[0].env;
+
+  t.ok(LOG_LEVEL, 'snyk-monitor has log level');
+  t.ok(LOG_LEVEL === 'INFO', 'snyk-monitor has correct log level');
+});
+
 tap.test('snyk-monitor has nodeSelector', async (t) => {
   t.plan(1);
 

test/setup/deployers/helm.ts

@@ -31,7 +31,8 @@ async function deployKubernetesMonitor(
       `--set image.pullPolicy=${imagePullPolicy} ` +
       '--set integrationApi=https://kubernetes-upstream.dev.snyk.io ' +
       '--set nodeSelector."kubernetes\\.io/os"=linux ' +
-      '--set psp.enabled=true'
+      '--set psp.enabled=true ' + 
+      '--set log_level="INFO"'
   );
   console.log(`Deployed ${imageOptions.nameAndTag} with pull policy ${imageOptions.pullPolicy}`);
 }