Ativar o registo de diagnóstico na API Azure para FHIREnable Diagnostic Logging in Azure API for FHIR

Neste artigo, você vai aprender como ativar o login de diagnóstico em AZure API para FHIR e ser capaz de rever algumas consultas de amostra para estes registos.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. O acesso aos registos de diagnóstico é essencial para qualquer serviço de saúde onde o cumprimento dos requisitos regulamentares (como o HIPAA) é obrigatório.Access to diagnostic logs is essential for any healthcare service where compliance with regulatory requirements (such as HIPAA) is a must. A funcionalidade em Azure API para FHIR que permite registos de diagnóstico são as definições de Diagnóstico no portal Azure.The feature in Azure API for FHIR that enables diagnostic logs is the Diagnostic settings in the Azure portal.

Ver e baixar dados de métricas FHIRView and Download FHIR Metrics Data

Pode ver as métricas em Monitorização | Métricas do portal.You can view the metrics under Monitoring | Metrics from the portal. As métricas incluem Número de Pedidos, Latência Média, Número de Erros, Tamanho dos Dados, RUs Utilizados, Número de pedidos que excederam a capacidade, e Disponibilidade (em %).The metrics include Number of Requests, Average Latency, Number of Errors, Data Size, RUs Used, Number of requests that exceeded capacity, and Availability (in %). A imagem abaixo mostra RUs usados para um ambiente de amostra com muito poucas atividades nos últimos 7 dias.The screenshot below shows RUs used for a sample environment with very few activities in the last 7 days. Pode descarregar os dados no formato Json.You can download the data in Json format.

Azure API para métricas FHIR do portal

Ativar registos de auditoriaEnable audit logs

  1. Para ativar a sessão de diagnóstico em Azure API para FHIR, selecione a sua API Azure para o serviço FHIR no portal AzureTo enable diagnostic logging in Azure API for FHIR, select your Azure API for FHIR service in the Azure portal

  2. Navegue para definições de DiagnósticoNavigate to Diagnostic settings

    Adicione as definições de diagnóstico Azure FHIR.

  3. Selecione + Adicionar definição de diagnósticoSelect + Add diagnostic setting

  4. Introduza um nome para a definiçãoEnter a name for the setting

  5. Selecione o método que pretende utilizar para aceder aos seus registos de diagnóstico:Select the method you want to use to access your diagnostic logs:

    1. Arquivar para uma conta de armazenamento para auditoria ou inspeção manual.Archive to a storage account for auditing or manual inspection. A conta de armazenamento que pretende utilizar já precisa de ser criada.The storage account you want to use needs to be already created.
    2. Transmita para o centro de eventos para ingestão por um serviço de terceiros ou solução analítica personalizada.Stream to event hub for ingestion by a third-party service or custom analytic solution. Você precisará criar um espaço de nome de eventos e política de centro de eventos antes de configurar este passo.You will need to create an event hub namespace and event hub policy before you can configure this step.
    3. Transmita para o espaço de trabalho Log Analytics no Azure Monitor.Stream to the Log Analytics workspace in Azure Monitor. Terá de criar o seu Espaço de Trabalho de Analítica de Logs antes de poder selecionar esta opção.You will need to create your Logs Analytics Workspace before you can select this option.
  6. Selecione AuditLogs e/ou AllMetrics.Select AuditLogs and/or AllMetrics. As métricas incluem nome de serviço, disponibilidade, tamanho de dados, latência total, pedidos totais, erros totais e marcação de tempo.The metrics include service name, availability, data size, total latency, total requests, total errors and timestamp. Pode encontrar mais detalhes sobre métricas suportadas.You can find more detail on supported metrics.

    Definições de diagnóstico Azure FHIR. Selecione AuditLogs e/ou AllMetrics.

  7. Selecione GuardarSelect Save

Nota

Pode levar até 15 minutos para os primeiros Registos mostrarem no Log Analytics.It might take up to 15 minutes for the first Logs to show in Log Analytics. Além disso, se a Azure API para fHIR for transferida de um grupo de recursos ou subscrição para outra, atualize a definição assim que o movimento estiver concluído.Also, if Azure API for FHIR is moved from one resource group or subscription to another, update the setting once the move is complete.

Para obter mais informações sobre como trabalhar com registos de diagnóstico, consulte a documentação do Registo de Recursos AzureFor more information on how to work with diagnostic logs, please refer to the Azure Resource Log documentation

Detalhes do registo de auditoriaAudit log details

Neste momento, a Azure API para o serviço FHIR devolve os seguintes campos no registo de auditoria:At this time, the Azure API for FHIR service returns the following fields in the audit log:

Nome do CampoField Name TipoType NotasNotes
Entidade CallerIdCallerIdentity DinâmicaDynamic Um saco de propriedade genérica contendo informações de identidadeA generic property bag containing identity information
CallerIdentityIssuerCallerIdentityIssuer StringString EmissorIssuer
CallerIdentityObjectIdCallerIdentityObjectId StringString Object_IdObject_Id
Endereço de chamadaIPAddressCallerIPAddress StringString O endereço IP do chamadorThe caller’s IP address
CorrelationIdCorrelationId StringString ID de CorrelaçãoCorrelation ID
FhirResourceTypeFhirResourceType StringString O tipo de recurso para o qual a operação foi executadaThe resource type for which the operation was executed
LogCategoriaLogCategory StringString A categoria de registo (estamos neste momento a devolver 'AuditLogs' LogCategoria)The log category (we are currently returning ‘AuditLogs’ LogCategory)
LocalizaçãoLocation StringString A localização do servidor que processou o pedido (por exemplo, South Central US)The location of the server that processed the request (e.g., South Central US)
OperaçãoDuraçãoOperationDuration intInt O tempo que demorou a completar este pedido em segundosThe time it took to complete this request in seconds
OperationNameOperationName StringString Descreve o tipo de operação (por exemplo, atualização, tipo de pesquisa)Describes the type of operation (e.g. update, search-type)
RequestUriRequestUri StringString O pedido URIThe request URI
ResultTypeResultType StringString Os valores disponíveis atualmente são Iniciados, Bem Sucedidos ou Falhados The available values currently are Started, Succeeded, or Failed
Código de EstadoStatusCode intInt O código de estado HTTP.The HTTP status code. (por exemplo, 200)(e.g., 200)
TimeGeneratedTimeGenerated DateTimeDateTime Data e hora do eventoDate and time of the event
PropriedadesProperties StringString Descreve as propriedades do fhirResourceTypeDescribes the properties of the fhirResourceType
SourceSystemSourceSystem StringString Sistema fonte (sempre Azure neste caso)Source System (always Azure in this case)
TenantIdTenantId StringString ID do inquilinoTenant ID
TipoType StringString Tipo de registo (sempre MicrosoftHealthcareApisAuditLog neste caso)Type of log (always MicrosoftHealthcareApisAuditLog in this case)
_ResourceId_ResourceId StringString Detalhes sobre o recursoDetails about the resource

Consultas de exemploSample queries

Aqui estão algumas consultas básicas de Insights de Aplicação que pode utilizar para explorar os seus dados de registo.Here are a few basic Application Insights queries you can use to explore your log data.

Faça esta consulta para ver os 100 registos mais recentes:Run this query to see the 100 most recent logs:

MicrosoftHealthcareApisAuditLogs
| limit 100

Executar esta consulta para operações de grupo por FHIR Resource Type:Run this query to group operations by FHIR Resource Type:

MicrosoftHealthcareApisAuditLogs 
| summarize count() by FhirResourceType

Faça esta consulta para obter todos os resultados falhadosRun this query to get all the failed results

MicrosoftHealthcareApisAuditLogs 
| where ResultType == "Failed" 

ConclusãoConclusion

Ter acesso a registos de diagnóstico é essencial para monitorizar um serviço e fornecer relatórios de conformidade.Having access to diagnostic logs is essential for monitoring a service and providing compliance reports. A Azure API para FHIR permite-lhe fazer estas ações através de registos de diagnóstico.Azure API for FHIR allows you to do these actions through diagnostic logs.

FHIR é a marca registada do HL7 e é utilizada com a permissão do HL7.FHIR is the registered trademark of HL7 and is used with the permission of HL7.

Passos seguintesNext steps

Neste artigo, aprendeu a permitir registos de auditoria para Azure API para FHIR.In this article, you learned how to enable Audit Logs for Azure API for FHIR. Em seguida, saiba mais sobre outras configurações adicionais que pode configurar na API Azure para FHIRNext, learn about other additional settings you can configure in the Azure API for FHIR