Skip to main content

Azure Monitor

Using Guzzle's Azure Monitor service, User can connect and send Guzzle Audits and Logs data to Log Analytics Workspace. User can also search and filter the logs, and setup monitoring or alerting mechanisms based on log or job audit events or may write a more advanced query to perform statistical analysis and visualize the results in a chart.

Setup Azure Monitor#

User can view the logs and audit data using Log Analytics Workspace

  • User can create new Log Analytics Workspace in Azure Portal or use default workspace
  • Copy Workspace ID and Primary Key value from Log Analytics Workspace > Agents management section
  • Configure Azure Monitor in Guzzle using Manage -> Environment Config > Azure Monitor > Enable section.
  • It requires Workspace ID and Primary Key of Log Analytics Workspace
  • User can specify Primary Key value or key vault secret name
  • By default, Guzzle creates two custom tables
    1. GuzzleJobAudit - to store Guzzle Job Audit data
    2. GuzzleLog - to store Guzzle Job and API logs
  • User can also override custom table names
  • As soon as User press update button, It will verify the credentials and store it in guzzle.yml and guzzle-api.yml file
guzzle:
azure_monitor:
workspace_id: "xxxxxxxx-xxxx-xxxx-xxxxx-xxxxx"
primary_key: "xxxxxxxxxxxx"
job_audit_custom_log_name: "GuzzleJobAudit"
job_log_custom_log_name: "GuzzleLog"

Custom Logs Tables#

  1. Guzzle Job Audit
  • When the Job execution is completed, It will generate Job Audit record in Log Analytics Workspace
  • Guzzle Job audit custom log includes the below custom fields
column namedata type
TimeGenerateddatetime
JobInstanceId_sstring
BatchId_sstring
ParentJobInstanceId_sstring
BusinessDate_tdatetime
batch_sstring
Name_sstring
Module_sstring
Tag_sstring
StartTime_tdatetime
EndTime_tdatetime
Status_sstring
Messagestring
ExecutorId_sstring
ScheduleId_sstring
SourceName_sstring
  1. Guzzle Log
  • It will use Guzzle custom logger to send Guzzle Job and API logs to Log Analytics Workspace
  • Guzzle Logs custom log includes the below custom fields
Column nameData type
TimeGenerateddatetime
JobInstanceId_sstring
Name_sstring
Module_sstring
Class_sstring
MethodName_sstring
ThreadName_sstring
Levelstring
Messagestring

Limitations#

  • If User updates credentials manually in guzzle.yml and guzzle-api.yml file. It required Guzzle API service to restart and in Analytics cluster It will take effect when new job is submitted or cluster is restarted.