Logs de SMS dos Serviços de Comunicação do Azure

Artigo
10/26/2023

Os Serviços de Comunicação do Azure oferecem funcionalidades de log que você pode usar para monitorar e depurar sua solução dos Serviços de Comunicação. Essas funcionalidades podem ser configuradas por meio do portal do Azure.

Importante

O exemplo a seguir refere-se aos logs habilitados por meio do Azure Monitor (confira também as perguntas frequentes). Para habilitar esses logs para os Serviços de Comunicações, confira: Habilitar o registro em log nas Configurações de Diagnóstico

Pré-requisitos

Os Serviços de Comunicação do Azure fornecem recursos de monitoramento e análise por meio da visão geral dos Logs do Azure Monitor e das Métricas do Azure Monitor. Cada recurso do Azure requer sua própria configuração de diagnóstico, o que define os seguintes critérios:

Categorias de logs e dados métricos enviados para os destinos definidos na configuração. As categorias disponíveis variam para diferentes tipos de recursos.
Um ou mais destinos para enviar os logs. Os destinos atuais incluem o espaço de trabalho do Log Analytics, Hubs de Eventos e Armazenamento do Azure.
Uma única configuração de diagnóstico pode definir apenas um de cada um dos destinos. Se você quiser enviar dados para mais de um tipo de destino específico (por exemplo, dois espaços de trabalho diferentes do Log Analytics), crie várias configurações. Cada recurso pode ter até cinco configurações de diagnóstico.

A seguir estão instruções para configurar seu recurso Azure Monitor para começar a criar logs e métricas para seus Serviços de Comunicação. Para obter documentação detalhada sobre como usar as Configurações de Diagnóstico em todos os recursos do Azure, consulte: Habilitar o log nas Configurações de Diagnóstico

Observação

Em nome da configuração de diagnóstico, selecione "SMS Operacional" para ativar os logs para SMS.

Visão geral

Os logs operacionais do SMS são registros de eventos e atividades que fornecem insights sobre suas solicitações de API de SMS. Eles capturaram detalhes sobre o desempenho e a funcionalidade da primitiva SMS, incluindo detalhes sobre o status da mensagem, se eles foram entregues com êxito, bloqueados ou não foram enviados. Os logs operacionais do SMS contêm informações que ajudam a identificar tendências e padrões, resolver problemas que podem estar afetando o desempenho, como entregas de mensagens com falha ou problemas de serviço. Os logs incluem os seguintes detalhes:

Mensagens enviadas.
Mensagem recebida.
Mensagens entregues.
Mensagens opt-in e opt-out.

Categorias de log de recursos

Os Serviços de Comunicação seguintes tipos de logs que você pode habilitar:

Logs de uso: fornecem dados de uso associados a cada oferta de serviço cobrada
Logs operacionais de SMS: fornecem informações básicas relacionadas ao serviço de SMS

Esquema de logs de uso

Propriedade	Descrição
`Timestamp`	O carimbo de data/hora (UTC) de quando o log foi gerado.
`Operation Name`	A operação associada ao registro de log.
`Operation Version`	A `api-version` associada à operação, caso a operationName tenha sido executada com uma API. Se não houver nenhuma API que corresponda a essa operação, a versão representará a versão dessa operação caso as propriedades associadas à operação sejam alteradas no futuro.
`Category`	A categoria de log do evento. Categoria é a granularidade na qual você pode habilitar ou desabilitar os logs em determinado recurso. As propriedades exibidas no blob de propriedades de um evento são as mesmas em uma categoria de log e um tipo de recurso específicos.
`Correlation ID`	A ID de eventos correlacionados. Pode ser usada para identificar os eventos correlacionados entre várias tabelas.
`Properties`	Outros dados aplicáveis a vários modos dos Serviços de Comunicação.
`Record ID`	A ID exclusiva de um registro de uso especificado.
`Usage Type`	O modo de uso. (por exemplo, chat, PSTN, NAT etc.)
`Unit Type`	O tipo de unidade em que o uso se baseia para um modo de uso especificado. (por exemplo, minutos, megabytes, mensagens etc.).
`Quantity`	O número de unidades usadas ou consumidas para este registro.

Logs operacionais de SMS

Propriedade	Descrição
`TimeGenerated`	O carimbo de data/hora (UTC) de quando o log foi gerado.
`OperationName`	A operação associada ao registro de log.
`CorrelationID`	A ID de eventos correlacionados. Pode ser usada para identificar os eventos correlacionados entre várias tabelas.
`OperationVersion`	A api-version associada à operação, caso a operationName tenha sido executada com uma API. Se não houver nenhuma API que corresponda a essa operação, a versão representará a versão dessa operação caso as propriedades associadas à operação sejam alteradas no futuro.
`Category`	A categoria de log do evento. Categoria é a granularidade na qual você pode habilitar ou desabilitar os logs em determinado recurso. As propriedades exibidas no blob de propriedades de um evento são as mesmas em uma categoria de log e um tipo de recurso específicos.
`ResultType`	O status da operação.
`ResultSignature`	O substatus da operação. Se essa operação corresponder a uma chamada à API REST, esse campo será o código de status HTTP da chamada REST correspondente.
`ResultDescription`	A descrição de texto estático desta operação.
`DurationMs`	A duração da operação em milissegundos.
`CallerIpAddress`	O endereço IP do chamador, caso a operação corresponda a uma chamada à API proveniente de uma entidade com um endereço IP disponível publicamente.
`Level`	O nível de severidade do evento.
`URI`	O URI da solicitação.
`OutgoingMessageLength`	O número de caracteres na mensagem de saída.
`IncomingMessageLength`	O número de caracteres na mensagem de entrada.
`DeliveryAttempts`	O número de tentativas feitas para entregar esta mensagem.
`PhoneNumber`	O número de telefone do qual a mensagem SMS está sendo enviada.
`SdkType`	O tipo de SDK usado na solicitação.
`PlatformType`	O tipo de plataforma usado na solicitação.
`Method`	O método usado na solicitação.
`NumberType`	O tipo de número do qual a mensagem SMS está sendo enviada. Pode ser LongCodeNumber ou ShortCodeNumber ou DynamicAlphaSenderID
`MessageID`	Representa o messageId exclusivo gerado para cada mensagem de saída e entrada. Isso pode ser encontrado no objeto de resposta da API do SMS
`Country`	Representar os países/regiões para os quais as mensagens SMS foram enviadas ou recebidas de

Exemplo de log enviado por SMS


    [
      {
        "TimeGenerated": "2022-09-26T15:58:30.100Z",
        "OperationName": "SMSMessagesSent",
        "CorrelationId": "dDRmubfpNZZZZZnxBtw3Q.0",
        "OperationVersion": "2020-07-20-preview1",
        "Category":"SMSOperational",
        "ResultType": "Succeeded",
        "ResultSignature": 202,
        "DurationMs": 130,
        "CallerIpAddress": "127.0.0.1",
        "Level": "Informational",
        "URI": "https://sms-e2e-prod.communication.azure.com/sms?api-version=2020-07-20-preview1",
        "OutgoingMessageLength": 151,
        "IncomingMessageLength": 0,
        "DeliveryAttempts": 0,
        "PhoneNumber": "+18445791704",
        "NumberType": "LongCodeNumber",
        "SdkType": "azsdk-net-Communication.Sms",
        "PlatformType": "Microsoft Windows 10.0.17763",
        "Method": "POST",
        "MessageId": "Outgoing_20230118181300ff00e5c9-876d-4958-86e3-4637484fe5bd_noam",
        "Country": "US"
      }
    ]

Exemplo de log de relatório de entrega de SMS


    [
      {
        "TimeGenerated": "2022-09-26T15:58:30.200Z",
        "OperationName": "SMSDeliveryReportsReceived",
        "CorrelationId": "tl8WpUTESTSTSTccYadXJm.0",
        "Category":"SMSOperational",
        "ResultType": "Succeeded",
        "ResultSignature": 200,
        "DurationMs": 130,
        "CallerIpAddress": "127.0.0.1",
        "Level": "Informational",
        "URI": "https://global.smsgw.prod.communication.microsoft.com/rtc/telephony/sms/DeliveryReport",
        "OutgoingMessageLength": 0,
        "IncomingMessageLength": 0,
        "DeliveryAttempts": 1,
        "PhoneNumber": "+18445791704",
        "NumberType": "LongCodeNumber",
        "SdkType": "",
        "PlatformType": "",
        "Method": "POST",
        "MessageId": "Outgoing_20230118181300ff00e5c9-876d-4958-86e3-4637484fe5bd_noam",
        "Country": "US"
      }
    ]

Exemplo de log recebido por SMS


    [
      {
        "TimeGenerated": "2022-09-27T15:58:30.200Z",
        "OperationName": "SMSMessagesReceived",
        "CorrelationId": "e2KFTSTSTI/5PTx4ZZB.0",
        "Category":"SMSOperational",
        "ResultType": "Succeeded",
        "ResultSignature": 200,
        "DurationMs": 130,
        "CallerIpAddress": "127.0.0.1",
        "Level": "Informational",
        "URI": "https://global.smsgw.prod.communication.microsoft.com/rtc/telephony/sms/inbound",
        "OutgoingMessageLength": 0,
        "IncomingMessageLength": 110,
        "DeliveryAttempts": 0,
        "PhoneNumber": "+18445791704",
        "NumberType": "LongCodeNumber",
        "SdkType": "",
        "PlatformType": "",
        "Method": "POST",
        "MessageId": "Incoming_2023011818121211c6ee31-63fe-477c-8d51-f800543c6694",
        "Country": "US"
      }
    ]

(veja também FAQ).

Compartilhar via