Abilitare la registrazione diagnostica nell'API di Azure per FHIREnable Diagnostic Logging in Azure API for FHIR

In questo articolo si apprenderà come abilitare la registrazione diagnostica nell'API di Azure per FHIR ed essere in grado di esaminare alcune query di esempio per questi log.In this article, you will learn how to enable diagnostic logging in Azure API for FHIR and be able to review some sample queries for these logs. L'accesso ai log di diagnostica è essenziale per qualsiasi servizio sanitario in cui la conformità ai requisiti normativi (ad esempio HIPAA) è una necessità.Access to diagnostic logs is essential for any healthcare service where compliance with regulatory requirements (such as HIPAA) is a must. La funzionalità dell'API di Azure per FHIR che Abilita i log di diagnostica è rappresentata dalle impostazioni di diagnostica del portale di Azure.The feature in Azure API for FHIR that enables diagnostic logs is the Diagnostic settings in the Azure portal.

Visualizza e Scarica i dati di metrica FHIRView and Download FHIR Metrics Data

È possibile visualizzare le metriche in monitoraggio | Metriche del portale.You can view the metrics under Monitoring | Metrics from the portal. Le metriche includono il numero di richieste, la latenza media, il numero di errori, le dimensioni dei dati, le UR usate, il numero di richieste che hanno superato la capacità e la disponibilità (in%).The metrics include Number of Requests, Average Latency, Number of Errors, Data Size, RUs Used, Number of requests that exceeded capacity, and Availability (in %). La schermata seguente mostra le UR usate per un ambiente di esempio con pochissime attività negli ultimi 7 giorni.The screenshot below shows RUs used for a sample environment with very few activities in the last 7 days. È possibile scaricare i dati in formato JSON.You can download the data in Json format.

Metriche dell'API di Azure per FHIR dal portale

Abilitare i log di controlloEnable audit logs

  1. Per abilitare la registrazione diagnostica nell'API di Azure per FHIR, selezionare l'API di Azure per il servizio FHIR nel portale di AzureTo enable diagnostic logging in Azure API for FHIR, select your Azure API for FHIR service in the Azure portal

  2. Passa a impostazioni di diagnosticaNavigate to Diagnostic settings

    Aggiungere le impostazioni di diagnostica di Azure FHIR.

  3. Selezionare + Aggiungi impostazione di diagnosticaSelect + Add diagnostic setting

  4. Immettere un nome per l'impostazioneEnter a name for the setting

  5. Selezionare il metodo che si vuole usare per accedere ai log di diagnostica:Select the method you want to use to access your diagnostic logs:

    1. Archiviare in un account di archiviazione per il controllo o l'ispezione manuale.Archive to a storage account for auditing or manual inspection. È necessario che l'account di archiviazione che si vuole usare sia già stato creato.The storage account you want to use needs to be already created.
    2. Trasmettere a hub eventi per l'inserimento da parte di un servizio di terze parti o di una soluzione analitica personalizzata.Stream to event hub for ingestion by a third-party service or custom analytic solution. Prima di poter configurare questo passaggio, è necessario creare uno spazio dei nomi dell'hub eventi e un criterio dell'hub eventi.You will need to create an event hub namespace and event hub policy before you can configure this step.
    3. Trasmettere all'area di lavoro log Analytics in monitoraggio di Azure.Stream to the Log Analytics workspace in Azure Monitor. Prima di poter selezionare questa opzione, è necessario creare l'area di lavoro log Analytics.You will need to create your Logs Analytics Workspace before you can select this option.
  6. Selezionare AuditLogs e/o AllMetrics.Select AuditLogs and/or AllMetrics. Le metriche includono il nome del servizio, la disponibilità, le dimensioni dei dati, la latenza totale, le richieste totali, gli errori totali e il timestamp.The metrics include service name, availability, data size, total latency, total requests, total errors and timestamp. È possibile trovare altre informazioni sulle metriche supportate.You can find more detail on supported metrics.

    Impostazioni di diagnostica di Azure FHIR. Selezionare AuditLogs e/o AllMetrics.

  7. Selezionare SalvaSelect Save

Nota

Potrebbero essere necessari fino a 15 minuti prima che il primo log venga visualizzato in Log Analytics.It might take up to 15 minutes for the first Logs to show in Log Analytics. Se, inoltre, l'API di Azure per FHIR viene spostata da un gruppo di risorse o una sottoscrizione a un'altra, aggiornare l'impostazione al termine dello spostamento.Also, if Azure API for FHIR is moved from one resource group or subscription to another, update the setting once the move is complete.

Per altre informazioni su come usare i log di diagnostica, vedere la documentazione relativa al log delle risorse di AzureFor more information on how to work with diagnostic logs, please refer to the Azure Resource Log documentation

Dettagli log di controlloAudit log details

Al momento, il servizio API di Azure per FHIR restituisce i campi seguenti nel log di controllo:At this time, the Azure API for FHIR service returns the following fields in the audit log:

Nome campoField Name TypeType NoteNotes
CallerIdentityCallerIdentity DynamicDynamic Contenitore di proprietà generico che contiene informazioni sull'identitàA generic property bag containing identity information
CallerIdentityIssuerCallerIdentityIssuer stringString IssuerIssuer
CallerIdentityObjectIdCallerIdentityObjectId stringString Object_IdObject_Id
CallerIPAddressCallerIPAddress stringString Indirizzo IP del chiamanteThe caller’s IP address
CorrelationIdCorrelationId stringString ID correlazioneCorrelation ID
FhirResourceTypeFhirResourceType stringString Il tipo di risorsa per cui è stata eseguita l'operazioneThe resource type for which the operation was executed
LogCategoryLogCategory stringString Categoria log (attualmente in fase di restituzione di ' AuditLogs ' LogCategory)The log category (we are currently returning ‘AuditLogs’ LogCategory)
LocationLocation stringString Il percorso del server che ha elaborato la richiesta (ad esempio, Stati Uniti centro-meridionali)The location of the server that processed the request (e.g., South Central US)
OperationDurationOperationDuration IntInt Tempo richiesto per completare la richiesta in pochi secondiThe time it took to complete this request in seconds
OperationNameOperationName stringString Descrive il tipo di operazione (ad esempio, Update, Search-Type)Describes the type of operation (e.g. update, search-type)
RequestUriRequestUri stringString L'URI della richiestaThe request URI
ResultTypeResultType stringString I valori disponibili attualmente sono Started, succeeded o failedThe available values currently are Started, Succeeded, or Failed
StatusCodeStatusCode IntInt Codice di stato HTTP.The HTTP status code. (ad esempio, 200)(e.g., 200)
TimeGeneratedTimeGenerated DatetimeDateTime Data e ora dell'eventoDate and time of the event
ProprietàProperties stringString Descrive le proprietà di fhirResourceTypeDescribes the properties of the fhirResourceType
SourceSystemSourceSystem stringString Sistema di origine (sempre Azure in questo caso)Source System (always Azure in this case)
TenantIdTenantId stringString ID tenantTenant ID
TypeType stringString Tipo di log (sempre MicrosoftHealthcareApisAuditLog in questo caso)Type of log (always MicrosoftHealthcareApisAuditLog in this case)
_ResourceId_ResourceId stringString Dettagli sulla risorsaDetails about the resource

Query di esempioSample queries

Di seguito sono riportate alcune query Application Insights di base che è possibile usare per esplorare i dati di log.Here are a few basic Application Insights queries you can use to explore your log data.

Eseguire la query per visualizzare i 100 log più recenti :Run this query to see the 100 most recent logs:

MicrosoftHealthcareApisAuditLogs
| limit 100

Eseguire questa query per raggruppare le operazioni per tipo di risorsa FHIR:Run this query to group operations by FHIR Resource Type:

MicrosoftHealthcareApisAuditLogs 
| summarize count() by FhirResourceType

Eseguire questa query per ottenere tutti i risultati non riuscitiRun this query to get all the failed results

MicrosoftHealthcareApisAuditLogs 
| where ResultType == "Failed" 

ConclusioneConclusion

L'accesso ai log di diagnostica è essenziale per il monitoraggio di un servizio e per la fornitura di report di conformità.Having access to diagnostic logs is essential for monitoring a service and providing compliance reports. API di Azure per FHIR consente di eseguire queste azioni tramite i log di diagnostica.Azure API for FHIR allows you to do these actions through diagnostic logs.

FHIR è il marchio registrato di HL7, usato con l'autorizzazione di HL7.FHIR is the registered trademark of HL7 and is used with the permission of HL7.

Passaggi successiviNext steps

In questo articolo si è appreso come abilitare i log di controllo per l'API di Azure per FHIR.In this article, you learned how to enable Audit Logs for Azure API for FHIR. Successivamente, informazioni sulle altre impostazioni che è possibile configurare nell'API di Azure per FHIRNext, learn about other additional settings you can configure in the Azure API for FHIR