Application Insights in Azure Monitor
  • 26 Oct 2023
  • 1 Minute to read
  • PDF

Application Insights in Azure Monitor

  • PDF

Article Summary

Using Azure Application Insights, you can ingest telemetry from DocFusion that makes generation, statistical and data metrics available through custom properties. The data can then be visualized using KQL for performance monitoring or tweaking. Note: Telemetry features only apply to on-premises instances of DocFusion and only Azure Monitor is currently supported as instrumentation. 

   

Configuration

To setup telemetry in Azure, provision your test templates and chains then configure your InsightsConnectionString parameter in the setup Overview for AppInsights using the following format:

InstrumentationKey="<Your-Key>";IngestionEndpoint="<URL>";LiveEndpoint="<URL>"

It may take a few minutes for data to display in the portal. Generation time on the server can be measured using custom availability testing and querying the custom properties.

You can also use the installation parameters file to configure your instrumentation and, to disable availability reporting, use a blank connection string in the InsightsConnectionString parameter.

Refer to this Microsoft guide for more help with setting up in Application Insights: Connection strings in Application Insights - Azure Monitor | Microsoft Learn

Note that firewall settings may need revision for telemetry to reach your instrumentation.

    

Custom Properties

For performance analysis, generator custom properties recorded for DocFusion V2 API methods are listed below. Refer to your API documentation for more information.

Ad Hoc Generation

GenerateDocumentGenerateDocumentFull
  • BusinessUnit
  • Source
  • JobReference
  • Template
  • TemplateVersion
  • Chain
  • GenerationTimeMs
  • GenerationErrorCode
  • PageCount
  • Success
  • JobStatus
  • ProcessTime
  • CompletionTime
  • StartTime
  • JobLogId
  • Workflow
  • WorkflowVersion
  • ProcessType
  • GenerationNode
  • InternalErrorMessage

                                   

  • BusinessUnit
  • Source
  • JobReference
  • Template
  • TemplateVersion
  • Chain
  • ChainVersion
  • Workflow
  • WorkflowVersion
  • RequestedTimeout
  • ProcessType
  • GenerationTimeMS
  • QueueTimeMS
  • GenerationErrorCode
  • PageCount
  • GenerationNode
  • InternalErrorMessage


       

   

Queued Generation

QueueJobForGenerationQueueJobForGenerationStreamed
  • BusinessUnit
  • Source
  • JobReference
  • Template
  • TemplateVersion
  • Chain
  • RequestedTimeout
  • Success
  • InternalErrorMessage
  • RequestSize
  • BusinessUnit
  • Source
  • JobReference
  • Template
  • Chain
  • RequestedTimeout
  • Success
  • InternalErrorMessage

    
GetQueuedJobStatusGetQueuedJobInformation
  • BusinessUnit
  • JobReference
  • JobStatus
  • InternalErrorMessage

  • BusinessUnit
  • JobReference
  • JobStatus
  • Success
  • StartTime
  • ProcessTime
  • CompletionTime
  • InternalErrorMessage

   
GetQueuedJobGenerateResultGetQueuedJobGenerateResultDataStreamed
  • BusinessUnit
  • JobReference
  • Success
  • CompletionTime
  • Template
  • TemplateVersion
  • Chain
  • ChainVersion
  • Workflow
  • WorkflowVersion
  • GenerationTimeMS
  • QueueTimeMS
  • GenerationErrorCode
  • PageCount
  • InternalErrorMessage
  • BusinessUnit
  • JobReference
  • Success
  • CompletionTime
  • Template
  • TemplateVersion
  • Chain
  • ChainVersion
  • Workflow
  • WorkflowVersion
  • GenerationTimeMS
  • QueueTimeMS
  • GenerationErrorCode
  • PageCount
  • InternalErrorMessage


GetQueuedJobRequest QueuedJobClear
  • BusinessUnit
  • JobReference
  • Success
  • Source
  • Template
  • TemplateVersion
  • Chain
  • ChainVersion
  • Workflow
  • WorkflowVersion
  • RequestedTimeout
  • ProcessType
  • InternalErrorMessage

  • BusinessUnit
  • JobReference
  • InternalErrorMessage

   

Logging & Statistics

GetGenerationSnapshotGetGenerationJobLog
  • FromDate
  • ToDate
  • InternalErrorMessage
  • JobLogId
  • InternalErrorMessage 

   

Data & Metadata

GetScenariosGetSchema
  • BusinessUnit
  • Template
  • TemplateVersion
  • InternalErrorMessage


  • BusinessUnit
  • Template
  • InternalErrorMessage
GetExternalReferences
  • BusinessUnit
  • Template
  • TemplateVersion
  • InternalErrorMessage



   

Resources




Was this article helpful?