ComUnity Platform
25.x
25.x
  • ComUnity Technical Overview
  • Getting Started
    • ComUnity Developer Toolkit
      • Login
      • Manage your account: Profile, Settings, and Actions
    • Manage your project
      • Create a project
      • Project Settings
      • General
      • Build and launch your project
      • Templates
      • App Users & Roles
      • Themes
      • Versions
      • Icon Management
      • Store URLs
      • Deploy
        • Environments
        • Manual Project Deployment Across Environments
        • Configuration
    • Organisations
      • Roles and Permissions
      • Organisational Management
      • Teams
  • Toolkit Guides
    • Data
      • Customising the Data Model
      • Manage Entities in the Data Model: Step-by-Step Guide
      • Setting Up Role-Based Permissions for Entities: Access Control Configuration
      • Creating Entity Associations: Configuring Table Links
      • Manage Inheritance in the Data Model: Configuring Entity Hierarchy and Inheritance
    • Screens
      • Integrated Navigation and UI Builder for Screens in the ComUnity Developer Toolkit
      • Building Screens
        • Screen Controls
        • Navigation
          • Lists in Navigation pages
            • Dynamic List Rendering in Navigation pages
            • Adding Sub-Screens to Navigation pages Using List Navigation
          • Page Link
        • Form
          • Screen Controls
          • Lists in Form pages
            • Static Item - List Item
            • Single Item - List Item
            • Entity Items - List Item
    • Custom Classes
    • Custom Website
      • Bindings
      • Pages
        • Page Development
        • Page Elements
        • Templates
        • Resources
    • Communications
      • Configuring Dynamic Action Templates for Event-Driven Communication Channels
        • Event Details: Understanding Data Sources for Dynamic Template Building
        • Email
        • SMS & WhatsApp
        • INAPP
        • Push Notifications
        • HTTP
      • Triggering the Communication Service
      • Communication Settings
    • Events and Notifications Management
    • Observability
      • Client Analytics
      • Metrics
      • Traces
    • Third Party Services
      • Azure Function Apps
      • Azure Logic Apps
      • Integrations
      • Microsoft Fabric
      • APIs
    • Services
      • Media Server
  • General Information
    • Debugging and editing your application code
  • Toolkit Tutorials
    • Build a Simple Blog App: The Beginner's Guide to ComUnity Development
    • Building a Comprehensive News App: Integrating In-App Messaging, Push Notifications, SMS, and Email
    • APIs
      • JSON Placeholder Todos API Integration in a Simple Blog App
      • Countries GraphQL API Integration Using the APIs feature in the Toolkit
      • Integrating the JSONPlaceholder Posts API Using the Toolkit’s OpenAPI Feature
      • OData Integration with the Bookings API Using the APIs feature
    • How to Configure In-App Notifications for User Profile Updates Using Communications
  • Enhancing Cases App: Real-time Comment Notifications
  • Reference articles
    • Glossary
    • Privacy by Design
    • OData
    • Razor
    • CRUD Functions
    • Mustache Templating
    • Temporal Tables
    • Integrating WhatsApp Business with the ComUnity Platform
    • Data Types
    • Field Types
    • Table Links
    • Release Notes
    • Keyboard Shortcuts
Powered by GitBook
On this page
  • Key Features
  • Observability Integration
Export as PDF
  1. Toolkit Guides

Observability

Observability feature offers a comprehensive suite of tools designed to enhance visibility and insight across your application's performance and usage. With a focus on user-friendliness, the standout aspect of our observability suite is its ease of setup—every feature can be enabled with just a click of a button, streamlining the integration of advanced monitoring capabilities into your workflow.

Key Features

  1. Client Analytics: Gain valuable insights into how your end-users interact with your application. Track user engagement, feature usage, and more to make informed decisions about future developments and enhancements.

  2. Metrics: Access a wide array of metrics that provide real-time data on the performance and health of your application. This feature allows you to monitor system behaviour, resource utilisation, and operational efficiency, enabling proactive issue resolution and optimisation.

  3. Traces: Dive deep into your application's processes with detailed traces that help you understand request flows, identify bottlenecks, and pinpoint areas for improvement. Tracing provides a granular view of your application's operation, from high-level overviews to detailed, step-by-step execution paths.

Observability Integration

The Toolkit's observability feature is designed to be environment-specific, necessitating its activation within each distinct deployment environment of your project. Follow these general steps to enable observability for your project's environment:

  1. Log In: Access the Toolkit by entering your credentials.

  2. Open Your Project: Locate and select your project within the Toolkit.

  3. Navigate to Observability: From the main menu, find and click on "Observability". You will be presented with instructions for enabling observability within your project.

  4. Access Environment Settings: Go to the Environmental Setting and select the Observability page to proceed with the setup.

  5. Activate Observability: Click the "Create Page Analytics Configuration" button. This initiates a background process to enable observability; wait until this process completes.

  6. Explore Observability Data: After activation, you can access detailed information regarding observability in your deployment environment. This includes tabs like "Client Analytics" "Metrics" and "Traces" each offering specific insights.

  7. Access Dashboards: To view your observability dashboards, use the main navigation to select "Observability." The default view will be "Client Analytics," but you can switch to "Metrics" or "Traces" to view their respective dashboards.

These steps ensure that you can effectively enable and utilise the observability features within your project, allowing you to monitor and analyse various aspects of your application's performance and user interactions across different deployment environments.

Access Environment Settings
Activate Page Analytics in Environmental Settings