Skip to main content

Download logs

As an admin user, you can download your environment logs from Prophecy without needing access to your Prophecy cluster or the assistance of Prophecy Support. This reduces the delay in debugging any issues with your Prophecy services.

Use case​

  • The overarching objective is to debug what is going on with your Prophecy services.
  • To achieve this, we've enabled admins to be able to download Prophecy logs and environment information so that they can upload them to Zendesk.

Download logs features​

You can use the Download Logs feature to capture logs using the Services and time selectors.

  • All services are selected by default.
  • The download supports one hour of logs from the Start Time.

The captured logs include all relevant Prophecy configurations, such as the following items:

  • Kubernetes cluster configuration
    • Resource quotas
    • Node configuration
  • Cluster custom resources
  • Config maps and files
  • Resource consumption logs
note

Sensitive information, such as customer preview data, credentials, tokens, or passwords, is scrubbed or redacted from the download bundle.

Enable Prophecy Downloads logs​

Before you can download logs, you must enable it in your private SAAS deployment.

See the following requirements for enabling the Prophecy logs:

  • Prophecy collects the logs of all pods and stores it in the Athena Pod.
  • Each pod uses an additional 500 MB ephemeral storage for temporary storage.
  • Athena requires additional storage of around 100 GB to store one week of logs.
  • A new container image fluentbit (gcr.io/prophecy-share/fluent-bit:2.2.3) is required for this feature.

To enable Minio in Athena and provide it a volume, follow these steps:

  1. Add env variables to Athena STS:
  - name: MINIO_ENDPOINT
    value: athena:9000
  - name: ENABLE_FLUENTBIT_SIDECARS
    value: "true"
  - name: RUN_ATHENA_MINIO
    value: "true"
  1. Add volume to Athena STS:
  volumeClaimTemplates:
  ...
  - apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      creationTimestamp: null
      name: minio-storage
    spec:
      accessModes:
      - ReadWriteOnce
      resources:
        requests:
          storage: 10Gi
      volumeMode: Filesystem
  1. Add volume mount to Athena:
  volumeMounts:
  ...
  - mountPath: /minio/data
    name: minio-storage
  1. Add the Minio port to Athena SVC:
  ports:
  ...
  - name: minio
    port: 9000
    protocol: TCP
    targetPort: 9000

To download logs in the Prophecy UI, follow these steps:

  1. Log in to the Prophecy UI as an admin user.
  2. Click on the three dots at the bottom left corner and select the Settings icon from the submenu.
  3. Navigate to the Admin main tab.
  4. Within the Admin main tab, access the Logs sub tab.
  5. Set the Services and Start Date/Time, and then click Download

After several seconds, the file will download via your browser. The download generates a compressed file containing logs, suitable for sharing with a Prophecy support engineer.