Aidbox User Docs
CtrlK
Run Aidbox locallyRun Aidbox in SandboxTalk to us Ask community
  • Aidbox FHIR platform documentation
    • Features
    • Architecture
  • Getting Started
    • Run Aidbox in Sandbox
    • Run Aidbox locally
    • Run Aidbox on AWS
    • Upload Sample Data
  • Tutorials
    • CRUD, Search Tutorials
      • Delete data
      • Set up uniqueness in Resource
      • Search Tutorials
        • Custom SearchParameter tutorial
        • Create custom Aidbox Search resource
        • Multilingual search tutorial
        • Migrate from Aidbox SearchParameter to FHIR SearchParameter
        • Change sort order by locale collation
    • Bulk API Tutorials
      • Synthea by Bulk API
      • $dump-sql tutorial
    • Security and Access Control Tutorials
      • Allow patients to see their own data
      • Restrict operations on resource type
      • Relationship-based access control
      • Creating user and set up full user access
      • Restricting Access to Patient Data
      • Create and test access control
      • RBAC
        • Flexible RBAC built-in to Aidbox
        • RBAC with JWT containing role
        • RBAC with ACL
      • Set-up token introspection
      • Prohibit user to login
      • Managing Admin Access to the Aidbox UI Using Okta Groups
      • Run Multibox locally
      • How to enable labels-based access control
      • How to enable patient data access API
      • How to enable SMART on FHIR on Patient Access API
      • How to enable hierarchical access control
      • How to configure FHIR Audit Log
      • How is an HTTP request processed in Aidbox
      • How to configure SSO with another Aidbox instance to access Aidbox UI
      • How to configure SSO with Okta to access Aidbox UI
      • How to configure sign-in with Apple for access to the Aidbox UI
      • How to configure Azure AD SSO for access to the Aidbox UI
      • How to configure Microsoft AD FS for access to the Aidbox UI
      • How to configure Azure AD SSO with certificate authentication for access to the Aidbox UI
      • How to configure GitHub SSO for access to Aidbox UI
      • How to configure Keycloak for access for AidboxUI
      • How to implement consent-based access control using FHIR Search and Aidbox Access Policy
      • Debug Access Control
      • AccessPolicy best practices
      • How to configure Basic Auth flow
      • How to configure Authorization Code Grant
      • How to configure Client Credentials Grant
      • How to configure Implicit Grant
      • How to configure Token Exchange
      • How to configure Resource Owner Grant flow
      • Configuring Two Factor Authentication in Aidbox Identity Provider
      • SSO with External OAuth Identity Provider
    • Terminology Tutorials
      • Load ICD-10 terminology into Aidbox
      • Uploading IG terminology content to external FHIR terminology server
      • Local Terminlogy
    • Validation Tutorials
      • ISiK
      • Carin BB
      • US Core
      • Davinci Pdex
      • mCode
    • Integration Toolkit Tutorials
      • Postmark integration tutorial
      • Mailgun integration tutorial
    • Subscriptions Tutorials
      • Kafka AidboxTopicDestination
      • ClickHouse AidboxTopicDestination
      • Tutorial: Produce QuestionnaireResponse to Kafka topic
      • GCP Pub/Sub AidboxTopicDestination
      • Webhook AidboxTopicDestination
      • AidboxTopicSubscription NATS tutorial
    • Artifact Registry Tutorials
      • How to create FHIR npm package
      • Define Extensions
        • Extensions using StructureDefinition
        • Extensions using FHIRSchema
      • Custom Resources
        • Custom resources using FHIR Schema
        • Custom resources using StructureDefinition
        • Migrate to FHIR Schema
          • Migrate custom resources defined with Entity and Attributes to FHIR Schema
          • Migrate custom resources defined with Zen to FHIR Schema
      • Upload FHIR Implementation Guide
        • Environment Variable
        • Aidbox UI
          • IG Package from Aidbox Registry
          • Public URL to IG Package
          • Local IG Package
        • Aidbox FHIR API
        • UploadFIG Tool
    • Other Tutorials
      • Run Aidbox with FHIR R6
      • Migrate from Multibox to Aidbox
      • SDC with Custom Resources
      • Migrate from legacy licence portal to Aidbox portal
      • Set up Aidbox with Postman
      • How to run Aidbox in GCP Cloud Run
      • How to run Aidbox using different Java
  • Overview
    • Licensing and Support
    • Aidbox User Portal
      • Projects
      • Licenses
      • Members
    • Aidbox UI
      • Aidbox Notebooks
      • REST Console
      • Database Console
      • Attrs Stats
      • DB Tables
      • DB Queries
    • Versioning
    • Release Notes
    • FAQ
    • Contact us
  • Configuration
    • Settings
    • Configure Aidbox and Multibox
    • Init Bundle
  • API
    • API Overview
    • REST API
      • CRUD
        • Create
        • Read
        • Update
        • Patch
        • Delete
      • FHIR Search
        • SearchParameter
        • Include and Revinclude
        • Chaining
      • Aidbox Search
      • Bundle
      • History
      • $everything on Patient
      • Other
        • Aidbox and FHIR formats
        • Capability Statement
        • $document
        • Observation/$lastn
        • $validate
        • SQL endpoints
        • $matcho
        • $to-format
        • Aidbox version
        • Health check
    • Bulk API
      • Configure Access Policies for Bulk API
      • $dump
      • $dump-sql
      • $dump-csv
      • $export
      • $load and /fhir/$load
      • $import and /fhir/$import
      • Aidbox.bulk data import
      • Bulk import from an S3 bucket
    • Batch/Transaction
    • GraphQL API
    • Other APIs
      • Plan API
        • Provider Directory API
          • Practitioner
          • PractitionerRole
          • Organization
          • OrganizationAffiliation
        • Plan API Overview
      • Archive/Restore API
        • Create-archive
        • Restore-archive
        • Prune-archived-data
        • Delete-archive
      • ETAG support
      • Cache
      • Changes API
      • RPC API
      • Sequence API
      • Encryption API
      • Batch Upsert
  • Access Control
    • Overview
    • Identity Management
      • User Management
      • Application/Client Management
    • Authentication
      • Basic HTTP Authentication
      • OAuth 2.0
      • Token Introspector
      • SSO with External Identity Provider
    • Authorization
      • Access Policies
      • SMART on FHIR
        • SMART Client Authorization
          • SMART App Launch
          • SMART backend services
        • SMART Client Authentication
          • SMART: Asymmetric (/"private key JWT") authentication
          • SMART: Symmetric (/"client secret") authentication
        • SMART: Scopes for Limiting Access
        • Pass Inferno tests with Aidbox
        • Example: SMART app launch using Aidbox and Keycloak
        • Example: SMART app launch using Smartbox and Keycloak
      • Scoped API
        • Organization-based hierarchical access control
        • Compartments API
        • Patient data access API
      • Label-based Access Control
    • Audit and Logging
  • Artifact Registry
    • Artifact Registry Overview
    • StructureDefinition
    • SearchParameter
    • CodeSystem
    • ValueSet
  • Terminology Module
    • Terminology Overview
    • FHIR Terminology
      • Coded Values
      • Profiles, Binding, and Validation
    • Aidbox Terminology Module
      • Setup
      • Hybrid Mode
      • Capabilities
  • Database
    • Database Overview
    • PostgreSQL Requirements
    • Database schema
    • PostgreSQL Extensions
    • AidboxDB
      • HA AidboxDB
    • Tutorials
      • Migrate to AidboxDB 16
      • Working with pgAgent
  • Modules
    • Profiling and validation
      • FHIR Schema Validator
        • Supported FHIR Implementation Guides (IGs)
        • Setup Aidbox with FHIR Schema validation engine
      • Skip validation of references in resource using request header
      • Asynchronous resource validation
    • Observability
      • Getting started
        • Run Aidbox with OpenTelemetry locally
        • How to export telemetry to the OTEL collector
      • Logs
        • How-to guides
          • OpenTelemetry logs
          • Elastic Logs and Monitoring Integration
          • Datadog log management integration
          • Loki log management integration
        • Tutorials
          • Log analysis and visualization tutorial
          • Export logs to Datadog tutorial
        • Extending Aidbox Logs
        • Technical reference
          • Log appenders
          • Log transformations
          • Log Schema
          • OTEL logs exporter parameters
      • Metrics
        • How-to guides
          • How to export metrics to the OTEL collector
          • Use Aidbox Metrics Server
          • Set-up Grafana integration
        • Technical reference
          • OpenTelemetry Metrics
          • OTEL metrics exporter parameters
      • Traces
        • How to use tracing
        • OTEL traces exporter parameters
    • Subscriptions
      • Aidbox Topic-Based Subscriptions
      • Aidbox SubSubscriptions
    • Aidbox Forms
      • Getting started
      • Aidbox Forms Interface
      • Aidbox UI Builder
        • UI Builder Interface
        • AI Assistant
        • Form creation
          • Form Settings
          • Widgets
          • Components
          • Entry Mode
          • Versioning
          • Form customisation in theme editor
          • Form signature
          • How-to guides
            • How to: Populate forms with data
            • How to extract data from forms
            • How to calculate form filling percentage
            • How to create a form with dynamical answers into questions
          • Multilingual forms
          • FHIRPath Expressions with Visual Editor
          • Data Extraction
          • Population
        • Import Questionnaire
        • Form sharing
        • Printing forms
          • Template-based PDF generation
        • FHIR versions
        • Offline forms
        • Embedding
          • Request Interception
        • Configuration
        • Forms multitenancy
        • Building reports using SQL on FHIR
        • Integration with external terminology servers
        • External FHIR servers as a data backend
        • Store attachments in S3-like storages
      • Access control in forms
      • Audit logging in forms
      • Aidbox Form Gallery
    • SQL on FHIR
      • $run operation
      • Defining flat views with view definitions
      • Query data from flat views
      • Reference
    • Integration Toolkit
      • C-CDA / FHIR Converter
        • List of Supported Templates
          • Admission Diagnosis Section (/V3)
          • Advance directives section (/entries optional) (/V3)
          • Advance directives section (/entries required) (/V3)
          • Allergies and intolerances section (/entries optional) (/V3)
          • Allergies and intolerances section (/entries required) (/V3)
          • Assessment Section
          • Chief Complaint Section
          • Chief Complaint and Reason for Visit Section
          • Complications Section (/V3)
          • Course of Care Section
          • DICOM Object Catalog Section - DCM 121181
          • Default Section Rules
          • Discharge Diagnosis Section (/V3)
          • Document Header
          • Encounters section (/entries optional) (/V3)
          • Encounters section (/entries required) (/V3)
          • Family History Section (/V3)
          • Functional Status Section (/V2)
          • General Status Section
          • Goals Section
          • Health Concerns Section (/V2)
          • History of Present Illness Section
          • Hospital Consultations Section
          • Hospital Course Section
          • Hospital Discharge Instructions Section
          • Hospital Discharge Physical Section
          • Hospital Discharge Studies Summary Section
          • Immunizations section (/entries optional) (/V3)
          • Immunizations section (/entries required) (/V3)
          • Medical (/General) History Section
          • Medical Equipment Section (/V2)
          • Medications Administered Section (/V2)
          • Medications section (/entries optional) (/V2)
          • Medications section (/entries required) (/V2)
          • Mental Status Section (/V2)
          • Notes
          • Nutrition Section
          • Objective Section
          • Operative Note Fluids Section
          • Operative Note Surgical Procedure Section
          • Past Medical History (/V3)
          • Payers Section (/V3)
          • Plan of Treatment Section (/V2)
          • Postprocedure Diagnosis Section (/V3)
          • Preoperative Diagnosis Section (/V3)
          • Problem section (/entries optional) (/V3)
          • Problem section (/entries required) (/V3)
          • Procedure Description Section
          • Procedure Disposition Section
          • Procedure Estimated Blood Loss Section
          • Procedure Implants Section
          • Procedure Specimens Taken Section
          • Procedures section (/entries optional) (/V2)
          • Procedures section (/entries required) (/V2)
          • Reason for Visit Section
          • Results section (/entries optional) (/V3)
          • Results section (/entries required) (/V3)
          • Review of Systems Section
          • Social History Section (/V3)
          • Vital signs section (/entries optional) (/V3)
          • Vital signs section (/entries required) (/V3)
        • How to deploy the service
        • Producing C-CDA documents
        • How to customize conversion rules
      • HL7 v2 integration
        • HL7 v2 integration with Aidbox project
        • Mappings with lisp/mapping
      • X12 message converter
      • Analytics
        • Power BI
      • Mappings
      • Email providers integration
        • Setup SMTP provider
    • SMARTbox | FHIR API for EHRs
      • Get started
        • Set up Smartbox locally
        • Deploy Smartbox with Kubernetes
      • (/G)(/10) Standardized API for patient and population services
      • The B11 decision support interventions
        • Source attributes
        • Feedback Sections
      • How-to Guides
        • Pass Inferno Tests with Smartbox
        • Perform EHR Launch
        • Pass Inferno Visual Inspection and Attestation
        • Revoke Granted Access
        • Set up EHR-level Customization
        • Check email templates
        • Setup email provider
        • Register Users
        • Set up SSO with Auth0
        • Publish Terms of Use Link Onto the Documentation Page
        • Find Out What Resources Were Exported During the $export Operation
        • Find Documentation Endpoint
      • Background Information
        • Considerations for Testing with Inferno ONC
        • Adding Clients for Inferno Tests
        • Multitenancy Approach
        • What Is Tenant
        • Email Templating
    • ePrescription
      • Getting Started
      • Authentication with mTLS
      • Pharmacies Synchronization
      • Prescribing
        • NewRx Message
        • CancelRx Message
        • How to Test Callback
      • Directory
        • DirectoryDownload Message
        • GetProviderLocation Message
        • AddProviderLocation Message
        • UpdateProviderLocation Message
        • DisableProviderLocation Message
      • Medications
        • FDB
      • References
        • Environment Variables
        • List of Metrics
      • Frequently Asked Questions
    • Other Modules
      • MPI — Master Patient Index
        • Get started
          • Deploy MPI with Kubernetes
          • Configure MPI module
        • Find duplicates: $match
        • Merging and Unmerging Records: $merge and $unmerge
        • Matching Model Explanation
        • Mathematical Details
      • MCP
      • AidboxTrigger
      • HL7v2
        • Getting Started
        • FHIR Resources
        • Default Mappings
        • Module Limitations
        • Message Lifecycle
  • File storage
    • AWS S3
    • GCP Cloud Storage
    • Azure Blob Storage
    • Oracle Cloud Storage
  • Deployment and maintenance
    • Deploy Aidbox
      • Run Aidbox on Kubernetes
        • Deploy Production-ready Aidbox to Kubernetes
        • Deploy Aidbox with Helm Charts
        • Highly Available Aidbox
        • Self-signed SSL Certificates
      • Run Aidbox on managed PostgreSQL
      • How to inject env variables into Init Bundle
    • Backup and Restore
      • Crunchy Operator (/pgbackrest)
      • pg_dump
      • pg_basebackup
      • WAL-G
    • Indexes
      • Get Suggested Indexes
      • Create Indexes Manually
  • App development
    • Use Aidbox with React
    • Aidbox SDK
      • Aidbox JavaScript SDK
      • Apps
      • NodeJs SDK
      • Python SDK
    • Examples
  • Reference
    • Settings Reference
      • General
      • FHIR
      • Security and Access Control
      • Modules
      • Database
      • Web Server
      • Observability
      • Zen Project
    • System Resources Reference
      • IAM Module Resources
      • SDC Module Resources
      • Base Module Resources
      • Bulk Module Resources
      • AWF Module Resources
      • Cloud Module Resources
      • HL7v2 Module Resources
      • SQL on FHIR Module Resources
    • Environment Variables
      • Aidbox Required Environment Variables
      • Optional Environment Variables
      • AidboxDB Environment Variables
    • FHIR Schema Reference
    • Email Providers Reference
      • Notification Resource Reference
      • Mailgun Environment Variables
      • Postmark Environment Variables
    • Aidbox Forms Reference
      • FHIR SDC API
      • Aidbox SDC API
      • Generating Questionnaire from PDF API
    • Aidbox SQL Functions
    • Matcho DSL Reference
  • Deprecated
    • Deprecated
      • Zen-related
        • RPC Reference
          • Aidbox
            • Mdm
              • aidbox.mdm/update-mdm-tables
              • aidbox.mdm/match
        • FTR
        • Aidbox Configuration Project
          • Run Aidbox Locally Using Aidbox Configuraiton Project
          • Aidbox Configuration Project Structure
          • Set up and Use Configuration Projects
          • Enable IGs
          • Repository
          • Seed Import
          • Manage Indexes in Zen Project
          • Seed v2
          • Migrate to Git Aidbox Configuration Projects
          • Aidbox Configuration Project Reference
            • Zen Configuration
            • Aidbox Project RPC Reference
            • aidbox.config/config
          • Custom Resources Using Aidbox Project
          • First-Class Extensions Using Zen
          • Zen Indexes
        • US Core IG
          • US Core IG Support Reference
        • Workflow Engine
          • Task
            • Aidbox Built-in Tasks
            • Task Executor API
            • Task User API
          • Workflow
            • Workflow User API
          • Services
          • Monitoring
        • FHIR Conformance Deprecated Guides
          • Touchstone FHIR 4.0.1 Basic Server
          • Touchstone FHIR USCore ClinData
          • How to Enable US Core IG
            • Start Aidbox Locally with US Core IG Enabled
            • Add US Core IG to a Running Aidbox Instance
          • HL7 FHIR Da Vinci PDex Plan Net IG
        • Terminology Deprecated Tutorials
          • Inferno Test-Suite US Core 3.1.1
        • API Constructor (/Beta)
        • Zen-Lang Validator
          • Write a Custom Zen Profile
          • Load Zen Profiles into Aidbox
        • FHIR Topic-Based Subscriptions
          • Set up SubscriptionTopic
          • Tutorial: Subscribe to Topic (/R4B)
          • R4B API Reference
            • Subscription API
        • FHIR Terminology Repository
          • FTR Specification
          • Create an FTR Instance
            • FTR from CSV
            • FTR from FHIR IG
            • FTR from FTR — Direct Dependency
            • FTR from FTR — Supplement
          • FTR Manifest
          • Load SNOMED CT into Aidbox
          • Load LOINC into Aidbox
          • Load ICD-10-CM into Aidbox
          • Load RxNorm into Aidbox
          • Load US VSAC Package to Aidbox
          • Import via FTR
        • Zen Search Parameters
        • Access Control Lists (/ACL)
      • Entity / Attribute
        • Entities and Attributes
        • First-Class Extensions Using Attribute
        • Custom Resources Using Entity
        • Working with Extensions
        • Aidbox Search Parameters
      • Forms
      • Other
        • Custom Search
        • SearchQuery
        • Subscribe to New Patient Resource
        • App Development Deprecated Tutorials
          • Receive Logs from Your App
            • X-Audit Header
          • Patient Encounter Notification Application
        • Other Deprecated Tutorials
          • Resource Generation with Map-to-Fhir-Bundle-Task and Subscription Triggers
          • APM Aidbox
          • Automatically Archive AuditEvent Resources in GCP Storage Guide
          • HL7 v2 Pipeline with Patient Mapping
          • How to Migrate to Apline Linux
          • How to Migrate Transaction Id to Bigint
          • How to Fix Broken Dates
          • Configure Multi-Tenancy
        • AidboxProfile
        • GCP Pub/Sub
        • Aidbox Terminology Module (deprecated page)
          • Concept (deprecated)
            • $translate-concepts (deprecated)
            • Handling hierarchies using ancestors (deprecated)
          • ValueSet (deprecated)
            • ValueSet Expansion (deprecated)
            • ValueSet Code Validation (deprecated)
            • Create a ValueSet (deprecated page)
          • CodeSystem (deprecated)
            • CodeSystem Concept Lookup (deprecated)
            • CodeSystem subsumption testing (deprecated)
            • CodeSystem Code Composition (deprecated)
          • Import External Terminologies (deprecated)
            • Import flat file (/CSV) (deprecated)
            • $import operation (deprecated)
            • Ready-to-use terminologies (deprecated)
          • $translate on ConceptMap (deprecated)
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Modules
  2. Observability
  3. Metrics

Technical reference

OpenTelemetry MetricsOTEL metrics exporter parameters
PreviousSet-up Grafana integrationNextOpenTelemetry Metrics

Last updated 5 days ago

Was this helpful?