Eclipse Che logo Eclipse Che Documentation
Home Blog Source Code

Documentation

  • Discover
    • What is Che?
    • What problems does Che solve?
    • Who is Che for?
    • When to use Che
    • Che architecture
      • What runs on your cluster
        • Operator and lifecycle management
        • DevWorkspace Operator and workspace pods
        • Gateway and request routing
        • Dashboard and workspace management
        • Server and namespace provisioning
        • Devfile registry and workspace templates
        • Plug-in registry
      • What developers get in a workspace
    • Supported platforms
    • Common user roles and tasks
  • Install
    • How the installation works
    • Requirements
      • Supported platforms
      • Size your cluster for Che
      • Scalability limits and multi-cluster deployments
      • Set up the chectl command-line tool
    • Install Che
      • Deploy on OpenShift
        • Deploy using the CLI
        • Deploy using the web console
        • Deploy using an external identity provider
      • Deploy on Kubernetes
        • Install Che on Microsoft Azure
        • Install Che on Amazon Elastic Kubernetes Service
        • Install Che on the virtual Kubernetes cluster
      • Deploy locally
        • Install Che on Red Hat OpenShift Local
        • Install Che on Minikube
        • Install Che on Minikube with Keycloak as the OIDC provider
      • Deploy in a restricted environment
        • Deploy in an air-gapped environment
      • Customize settings during deployment
      • Permissions
        • Permissions required for CLI installation
        • Permissions required for web console installation
    • Confirm Che is running
    • Get the dashboard URL to share with your team
    • Prepare Che for your team
    • Remove Che from your cluster
  • Get Started as an Administrator
    • Prepare the platform for developers
      • Your first week as a platform administrator
      • Verify the platform works end-to-end
      • Configure GitHub OAuth for your team
      • What to configure next
  • Get Started as a Developer
    • Create your first cloud workspace
      • Your first-day experience
      • Open your project in a cloud development environment
      • Manage your cloud development environments
    • Connect to your Git repositories
      • How Git authentication works in cloud development environments
        • Access private repositories with a personal access token
  • Troubleshoot
    • Troubleshoot workspaces
      • When something goes wrong
      • View Cloud Development Environment logs
        • Cloud Development Environment logs
        • View workspace logs in CLI
        • View language server and debug adapter logs in the editor
      • Debug a failing workspace
      • Diagnose slow Cloud Development Environments
      • Fix webview loading errors in private browsing
      • Fix devfile errors
    • Troubleshoot the platform
      • View workspace logs in Kubernetes console
      • Collect diagnostics with must-gather
      • Diagnose workspace startup failures
      • Troubleshoot network problems
      • Fix OAuth configuration errors
  • User Guide
    • Start a cloud development environment from a raw devfile URL
    • Optional parameters for the URLs for starting a new workspace
      • URL parameter concatenation
      • URL parameter for the IDE
      • URL parameter for the IDE image
      • URL parameter for starting duplicate workspaces
      • URL parameter for the devfile file name
      • URL parameter for the devfile file path
      • URL parameter for the workspace storage
      • URL parameter for additional remotes
      • URL parameter for a container image
      • URL parameter for a memory limit
      • URL parameter for a CPU limit
      • URL parameter for the existing workspace name
      • URL parameter for the AI provider
    • Restoring workspaces from backups
      • Restoring a workspace from a backup
      • Viewing backups in the dashboard
    • Using the fuse-overlayfs storage driver for Podman and Buildah
      • Accessing /dev/fuse
      • Enabling fuse-overlayfs with a ConfigMap
    • Running containers with kubedock
    • Prevent workspace idling for long-running commands
    • Using Che in team workflow
      • Badge for first-time contributors
      • Reviewing pull and merge requests
      • Try in Web IDE GitHub action
    • Customizing workspace components
    • Introduction to devfile in Che
    • IDEs in workspaces
      • Microsoft Visual Studio Code - Open Source
      • Connecting Visual Studio Code to a Che workspace
      • Defining a common IDE
    • Using AI assistants in workspaces
      • Configuring an AI provider API key
      • Changing the AI tool on a workspace
    • Using credentials and configurations in workspaces
      • Mounting Secrets
        • Creating image pull Secrets
        • Access private repositories with a personal access token
      • Mounting ConfigMaps
        • Mounting Git configuration
        • Mounting SSH configuration
      • Enabling artifact repositories in a restricted environment
        • Maven
        • Gradle
        • npm
        • Python
        • Go
        • NuGet
    • Requesting persistent storage for workspaces
    • Integrating with Kubernetes
      • Managing workspaces with Kubernetes APIs
      • Automatic Kubernetes token injection
      • Navigating Che from OpenShift Developer Perspective
      • Navigating OpenShift web console from Che
  • Upgrade
    • Upgrade Che
      • Choose how updates are applied
      • Approve a pending upgrade in the web console
      • Upgrade Che from the command line
      • Upgrade in an air-gapped environment
      • Update the chectl management tool
      • Fix a duplicate DevWorkspace Operator after a cluster upgrade
  • Secure
    • Protect your deployment
    • Control who can access Che
      • Grant additional permissions to users
      • Restrict access to specific users and groups
      • Remove user data for GDPR compliance
  • Optimize performance
    • What you can optimize in Che
    • Speed up workspace starts with image caching
      • How image caching speeds up workspace starts
      • Deploy Image Puller on a Kubernetes cluster
      • Deploy Image Puller from the command line
      • Deploy Image Puller from the web console
      • Cache default Che images on all nodes
      • Cache your organization’s custom images
      • Cache additional images for faster starts
      • Review the default images cached by Image Puller
    • Scale the platform automatically
      • Scale Che for high availability
      • Prevent workspace failures during node scaling
    • Verify workspace performance after optimization
  • Administration Guide
    • Configuring Che
      • Understanding the CheCluster Custom Resource
        • Customize settings during deployment
        • Using the CLI to configure the CheCluster Custom Resource
        • CheCluster Custom Resource fields reference
      • Configuring namespaces
        • Configuring namespace name
        • Provisioning namespaces in advance
        • Configuring a user namespace
        • Configuring direct namespace creation on OpenShift
      • Configuring server components
        • Mounting a Secret or a ConfigMap as a file or an environment variable into a Eclipse Che container
        • Advanced configuration options for Che server
      • Configuring workspaces globally
        • Limiting the number of workspaces that a user can keep
        • Limiting the number of workspaces that all users can run simultaneously
        • Enabling users to run multiple workspaces simultaneously
        • Git with self-signed certificates
        • Configuring workspaces nodeSelector
        • Configuring allowed URLs for Cloud Development Environments
        • Enabling container run capabilities
      • Configuring observability
        • The Woopra telemetry plugin
        • Creating a telemetry plugin
          • Configuring server logging
          • Collecting logs using chectl
          • Collect diagnostics with must-gather
          • Monitoring the DevWorkspace Operator
          • Monitoring Che Server
      • Configuring networking
        • Configure network policies
        • Configuring Che hostname
        • Configuring Che with self-signed certificates
        • Importing untrusted TLS certificates to Che
        • Adding labels and annotations
        • Configuring workspace endpoints base domain
        • Configuring proxy
      • Configuring storage
        • Configuring storage classes
        • Configuring the storage strategy
        • Configuring storage sizes
        • Persistent user home
      • Configuring dashboard
        • Configuring getting started samples
        • Configuring editors definitions
        • Show deprecated editors
        • Configuring default editor
        • Concealing editors
        • Configuring editors download urls
        • Configuring AI providers
          • AI provider API key secret reference
        • Customizing OpenShift Eclipse Che branding images
      • Configuring OAuth for Git providers
        • Configuring OAuth 2.0 for GitHub
        • Configuring OAuth 2.0 for GitLab
        • Configuring OAuth 2.0 for a Bitbucket Server
        • Configuring OAuth 2.0 for the Bitbucket Cloud
        • Configuring OAuth 1.0 for a Bitbucket Server
        • Configuring OAuth 2.0 for Microsoft Azure DevOps Services
      • Configuring fuse-overlayfs
        • Enabling access to for OpenShift version older than 4.15
        • Enabling fuse-overlayfs for all workspaces
      • DevWorkspace backup
        • Integrated OpenShift container registry
        • Regular OCI-compatible registry
    • Managing IDE extensions
      • Extensions for Microsoft Visual Studio Code - Open Source
      • Configure the Open VSX registry URL
      • Enable the managed Open VSX registry
      • Deploy Open VSX from source
      • Deploy Open VSX from a workspace
      • Configure internal Open VSX access
      • Delete an extension using the Open VSX API
      • Delete an extension from the PostgreSQL database
    • Configuring Visual Studio Code - Open Source ("Code - OSS")
      • Configuring single and multiroot workspaces
      • Configure trusted extensions for Microsoft Visual Studio Code
      • Configure default extensions
      • Manage extension installation with ConfigMap
      • Applying editor configurations
    • Using the Che server API
    • Extensions
      • OpenShift Connector
        • Features of OpenShift Connector
        • Installing OpenShift Connector in Eclipse Che
        • Authenticating with OpenShift Connector from Eclipse Che
        • Creating Components with OpenShift Connector in Eclipse Che
        • Connecting source code from GitHub to a OpenShift Component
    • Che glossary
Documentation next
  • Documentation
    • next
  • Documentation
  • Administration Guide
  • Configuring Che
  • Configuring observability
Edit this Page

Configuring observability

To configure Che observability features, see:

  • Configuring server logging

  • Collecting logs using chectl

  • Collect diagnostics with must-gather

  • Monitoring the DevWorkspace Operator

  • Monitoring Che Server

Eclipse Foundation | Privacy Policy | Terms of Use | Eclipse Public License | Legal Resources