Nuvem

1º Go to Policies on LINK

2º Create new policie with bellow content

3º Go to AWS Console in IAM Service and create an use

Police Content

#About

This policy Allows:

  • EC2 Provisioning, control and manage instances with TAG “1P”. Our agent doesn’t use Key pair.
  • RDS, Elasticache, EC2, IAM, Cloudwatch and S3 in list and get requests types
  • EKS Full Access (Optionally)

1º Acesse o link de acesso ao Portal Azure https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredApps

2º Clique em New registration, e no campo “name” coloque a identificação 1p-agent de acordo com a imagem abaixo e depois clique em create.

3º clique em Certificates & secrets, em seguida New client secret, no campo de Description coloque a identificação 1p-agent-secret e programe para expirar em 24 meses, depois clique em Add para adicionar.

Após finalizar essa etapa, guarde a identificação apresentada no campo de value , essa informação será utilizada posteriormente para o cadastro da nuvem no 1P.

4º Clique em Overview na barra lateral e copie as informações no campo Application (client) ID and Directory (tenant) ID .

Guarde essas credenciais junto com as informações salvas no passo 3. Serão utilizadas também na configuração da nuvem no 1P.

5º Na barra de pesquisa do portal busque por subscriptions e acesse, como na imagem abaixo.

6º Copie a informação apresentada no campo subscriptionsID e mantenha salva na área de transferência, depois clique no link do campo subscription Name field

7º Dentro da área de subscription Name acesse Access Control (IAM) na barra lateral e em depois encontre o campo Create a custom role e clique em ADD.

8º Nas opções apresentadas na barra superior, clique em JSON, edite e insira o código abaixo.

Para que o código seja executado com sucesso, é necessário inserir o subscription ID que está na sua área de transferência de acordo com o passo 6 na área determinada no script abaixo.

O subscription ID deve ser inserido na sexta linha substituindo toda a informação PASTE THE SUBSCRIPTION ID HERE.

  {

    “properties”: {

        “roleName”: “1p-agent-role”,

        “description”: “1p role”,

        “assignableScopes”: [

            “/subscriptions/PASTE THE SUBSCRIPTION ID HERE

        ],

        “permissions”: [

            {

                “actions”: [

                    “Microsoft.Compute/*/read”,

                    “Microsoft.Compute/availabilitySets/*”,

                    “Microsoft.Compute/virtualMachines/*”,

                    “Microsoft.Compute/disks/*”,

                    “Microsoft.Network/*/read”,

                    “Microsoft.Network/publicIPAddresses/*”,

                    “Microsoft.Network/networkInterfaces/*”,

                    “Microsoft.Network/networkSecurityGroups/*”,

                    “Microsoft.Network/networkInterfaces/write”,

                    “Microsoft.Network/virtualNetworks/subnets/join/action”,

                    “Microsoft.Storage/storageAccounts/*”,

                    “Microsoft.Resources/*/read”,

                    “Microsoft.Resourcehealth/healthevent/*”,

                    “Microsoft.Resources/tags/*”,

                    “Microsoft.Resources/marketplace/purchase/*”,

                    “Microsoft.Resources/subscriptions/resourceGroups/*”

                ],

                “notActions”: [],

                “dataActions”: [],

                “notDataActions”: []

            }

        ]

    }

}

9º Clique em Save

[imagem do json aplicado]

10º Clique next, e em seguida em create para criar a nova role.

 

11º Ainda dentro do painel Access Control (IAM) , clique em Add role assignments. No campo Função coloque a identificação 1p-agent-role , em Select insira a informação 1p-agentdepois clique em Save. [depois de associado, seguir com a config do 1P - clique aqui]

Após estes passos, o usuário Azure estará criado e pronto para seguir com a configuração de nuvem do 1P

Em primeiro lugar, será preciso definir os provedores de nuvem.

Clique em “Clouds” na barra lateral.

Um botão “NEW” vai aparecer, quase no cabeçalho da página. Clique nesse botão

Defina a nuvem por:

  • AWS
  • AZURE
  • Custom

(selecionando a nuvem)

 

Ao selecionar a nuvem que deseja definir, surgirão mais configurações de acordo com a sua necessidade.

(configuração para AWS Cloud)

(configuração para Azure Cloud)

 

Em seguida, dê um nome para a nuvem que está configurando. (Não precisa, necessariamente, ser o nome associado à nuvem do seu produto).

Você pode cadastrar os provedores de nuvem de acordo com a quantidade disponível no seu plano. Para saber mais sobre planos, clique aqui.

Ambiente

Depois de configurar o provedor de nuvem, temos que configurar os ambientes.

Clique em “Environments” na barra lateral.

Um botão “NEW” vai aparecer, quase no cabeçalho da página. Clique nesse botão

Nesta etapa, será necessário:

  • Definir um nome para o ambiente
  • Atribuir a um provedor de nuvem cadastrado no passo acima
  • Designar uma tag

(cadastro de novo ambiente)

 

Quando atribuir uma das nuvens cadastradas, aparecerão novas configurações de acordo com a necessidade da nuvem designada.

(configuração para AWS Cloud)

(configuração para Azure Cloud)

 

Dica: o ideal é que o nome e tag cadastrados sejam utilizados como no seu ambiente, para associação e comunicação com a One Platform.

Você pode cadastrar ambientes de acordo com a quantidade disponível no seu plano. Para saber mais sobre planos, clique aqui.

Planos & Preços

Produto

É onde encontramos a Matriz de Resiliência com as informações geradas pela One Platform (1P).

Clique em “Products” na barra lateral.

Um botão “NEW” vai aparecer, quase no cabeçalho da página. Clique nesse botão

Nesta etapa, será necessário:

  • Inserir um nome
  • Campo para descrição
  • Selecione os teams que irão administrar o produto

Dica: o cadastro das equipes de trabalho (Teams) pode ser feito no cadastro do produto.

Após criar um produto, é necessário configurar as aplicações para finalizar a matriz de resiliência e iniciar o monitoramento.

Para inserir as aplicações dentro do seu produto, clique em “new resource” e então abrirá um pop up com 3 tipos de cadastro de aplicações, diferenciando o tipo de monitoramento que será feito:

Aplicação interna: Você precisa ter o agente instalado em sua nuvem. Você também pode adicionar dependências.

  • Agente requerido
  • Permitir dependências

Aplicativo externo com dependências: Você precisa ter o agente instalado em sua nuvem. Você também pode adicionar dependências.

  • Agente requerido
  • Permitir dependências

Monitoramento de aplicativos via webhook: Registramos ocorrências e falhas recebidas via webhook.

  • Sem agente
  • Sem dependências

Configurar Aplicação: Aplicação interna

Irá abrir um novo popup na tela atual. Nesta etapa, será necessário:

  • Escolher um ambiente
  • Inserir um nome a aplicação
  • Inserir healthcheck URL
  • Selecionar o método
  • Preencher ‘validations string’
  • Definir o intervalo e timeout (estão com configuração padrão, pode mudar se necessário)

Com essas configurações está disponível para criar uma aplicação para o produto cadastrado. São informações obrigatórias.

Ao selecionar o campo method, poderão surgir mais configurações de acordo com a sua necessidade.

Configurar Aplicação: Aplicativo externo com dependências

Irá abrir um popup na tela atual, semelhante a tela de cadastro de aplicações internas, como apresentado no tópico acima. Nesta etapa, será necessário configurar:

  • Escolher um ambiente
  • Inserir um nome a aplicação
  • Inserir healthcheck URL
  • Selecionar o método
  • Preencher ‘validations string’
  • Definir o intervalo e timeout (estão com configuração padrão, pode mudar se necessário)

O que é external monitoring e quando habilitar?

A função de external monitoring atua fazendo o monitoramento através de um agente externo (como se fosse um usuário sem acesso ao provedor da nuvem) para gerar os dados e a matriz de resiliência.

Configurar Aplicação: Monitoramento de aplicativos via webhook

O cadastro de aplicações monitoradas via webhook dentro do 1P é simples e rápido.

Nesta etapa será necessário:

  • Selecionar o Ambiente
  • Escolher um nome para aplicação que será utilizado para identificação no 1P

Após o cadastro da aplicação com monitoramento via webhook, você será direcionado a página de aplicação criada.

Após a configuração dos passos anteriores, a One Platform irá inserir um agente no seu provedor de nuvem que faz o monitoramento interno e gera a matriz de resiliência para o seu produto.

A função de external monitoring atua fazendo o monitoramento através de um agente externo (como se fosse um usuário sem acesso ao provedor da nuvem) para gerar os dados e a matriz de resiliência.

Se a função estiver ativada (em verde) será feito o monitoramento externo. Caso você desabilite a função (em cinza) o monitoramento será feito pelo agente interno.

Você pode cadastrar aplicações de acordo com a quantidade disponível no seu plano. Para saber mais sobre planos, clique aqui.

Funcionalidade disponível junto às métricas da aplicação para monitoramento do desempenho e impacto de deploys.

O gráfico mostra o tempo de resposta entre o agente do 1P e a aplicação através da rota determinada pela health check URL. Apresentando também os deploys realizados na timeline, com o intuito de monitorar o impacto na aplicação após a mudança.

Apresenta os dados das últimas 24 horas como configuração padrão e no canto superior à direita é possível encontrar ferramentas para modificar a coleta de informações, como o intervalo da checagem e recortar alguma oscilação necessária para análise mais específica.

Saiba quais são as funcionalidades extras no gráfico de latência e deployments

Temos quatro funções básicas nessa funcionalidade: ajuste de zoom manual, ícone de movimentação, ajustar para zoom padrão e exportar as informações. Saiba mais sobre cada uma delas abaixo:

Selection Zoom: Com a função ativada é possível selecionar uma parte do gráfico e isolar um intervalo específico. Os botões de mais e menos são complementares e proporcionam um zoom geral do gráfico.

(ação selection zoom)

Panning: utilizada para seleção e movimentação horizontal do gráfico, para um intervalo a frente ou histórico passado.

(ação panning)

Reset Zoom: simbolizada com uma casa, serve para ajustar o zoom do gráfico ao padrão de last 24 hours. Basta clicar e o gráfico será ajustado automaticamente.

More: representado com 3 linhas, são ações de exportação das informações apresentadas no gráfico.

Você pode exportar o conjunto de dados nos formatos:

  • SVG
  • PNG
  • CSV

(ação de download)

Entenda sobre deployments no gráfico

Quando seu time de desenvolvimento lança uma alteração em algum serviço é extremamente necessário o monitoramento constante desta aplicação, para saber se houve melhora ou piora no seu desempenho.

Ao inserir um deploy dentro da aplicação do seu produto no 1P, temos o registro apresentado no gráfico do dia e hora em que foi realizada a alteração, assim identificando se houve impacto no tempo de resposta após o lançamento.

O registro de deploy fica gravado também na timeline da aplicação, junto com as notificações de incidentes.

A funcionalidade de “Call Rotation” é designada para distribuição de notificações em casos de plantonistas, escalas de times e notificação via sms e ligação.

O Call Rotation é configurado por equipe. E será acionado em caso de incidente para todos os produtos que são monitorados pelo time determinado.

Funciona em paralelo com os canais de notificações pré-configurados na aba de “Notificações”; contudo, o Call Rotation é exclusivo para notificações via SMS e por chamada telefônica.

Antes de iniciar a configuração de escala do Call Rotation, é necessário que os usuários cadastrados no time estejam com o número de telefone celular validado na plataforma. Caso não estejam, não receberão a ligação ou SMS.

Para fazer a validação de telefone celular, basta clicar aqui..

Como configurar o Call Rotation

Como dito anteriormente, a funcionalidade de Call Rotation é configurada por time. Então precisa acessar o time para iniciar a configuração.

Segue abaixo todas as formas de acessar as configurações do time desejado.

Acesso ao time via Produto:

Clique em “Product” na barra lateral. E depois selecione o produto que tenha o time que deseja configurar.

Na barra superior, ao lado de “Availability”, onde mostra sua Matriz de Resiliência, há uma aba “Teams”. Selecione o time desejado nessa aba e você será redirecionado para a configuração do time.

Dica: caso você acesse o time através do Produto, não significa que será configurado escala de Call Rotation apenas para o Produto selecionado. A configuração é feita por time, e caso esse time esteja atribuído em outro produto, será inserido na escala de Call Rotation notificação de incidentes para os dois ou mais produtos. Este acesso é apenas para localizar o time desejado.

 

Acesso ao time via menu lateral:

Clique em “Teams” na barra lateral. E depois selecione o time que deseja configurar.

Na barra superior, selecione a aba com o nome de “Call Rotation” ao lado de “Notificações”

Lembrando: a escala de Call Rotation será configurada para todos os produtos monitorados por este time.

Entendendo as formas de montar a escala do seu time

A escala é criada a partir de “eventos” que podem ser determinados por dia, semana ou mês.

Você consegue criar um evento individual para um dia, clicando na data do calendário ao lado, e/ou segurando e arrastando o cursor do mouse desde a data de início, para a data de fim criando eventos com repetição.

Pode ser um dia, dois dias, quatro dias, uma semana completa, quinze dias ou todo o mês. Como for necessário de acordo com a demanda da sua equipe.

 

Após selecionada as datas desejadas, iremos completar as informações do evento. As informações a seguir serão sempre referente a um dia! Caso você tenha selecionado mais datas, o evento será repetido.

Resultando assim, em um evento com repetição diária, semanal ou mensal com as informações de um dia para o time. Semelhante ao Google Calendar.

 

Configurando o evento

Após seguir os passos e recomendações já descritas, sua página do OnePlatform estará semelhante a screenshot abaixo:

Adicione o horário de início e de término do time, de acordo com o horário diário. O formato de hora é de 24h. Caso a escala seja noturna, basta adicionar o horário correspondente à noite e à manhã que o sistema faz a distribuição automática do evento de um dia ao outro.

Step Group são as pessoas que serão responsáveis em responder por incidentes nesta escala. Basta selecionar qual grupo deseja atribuir as notificações.

Caso seja a primeira vez que está configurando o Call Rotation, é necessário criar um Step Group clicando no .

Para criar o Step Group: escolha primeiro colaborador da escala a ser notificado, selecione entre as opções de SMS ou Voice Call e configure o intervalo de tempo que será enviado o alerta e durante quanto tempo deverá alertado este primeiro colaborador até seguir o fluxo.

Adicione outro colaborador da escala em "add step", seguindo as mesmas configurações e opções de acionamento.

Dica: apenas estarão disponíveis os usuários com o número de telefone celular verificado. Caso o colaborador não apareça, é ele porque precisa verificar o número de telefone celular.

Dica: caso queira notificar o mesmo colaborador via SMS e Voice Call, basta adicioná-lo duplicado em sequência e selecionar um métodos de notificação para cada step.

A configuração do Step Group é individual para cada cliente e pode conter a quantidade de colaboradores necessários.

Imagem ilustrativa para apresentação de configuração de Step Group.

Para finalizar as configurações do Step Group, dê um nome para o fluxo criado e em seguida, clique em salvar.

Você também pode escolher a cor para diferenciar uma escala da outra, editar ou excluir o Step Group.

Este Step Group ficará salvo no Call Rotation para configurar mais eventos utilizando o mesmo fluxo.

 

Configuradas as datas, o horário e colaboradores para a escala, basta clicar em criar para cadastrar os eventos do Call Rotation.

Imagem ilustrativa do calendário após a criação dos eventos.

Acesse a aplicação que deseja configurar o monitoramento, e clique no botão “Hits and Failures API”

Então abrirá um popup na tela onde contém as informações que serão utilizadas na comunicação entre o seu ambiente e o 1P, para análise de dados, desenvolvimento da matriz de resiliência, controle de incidentes e outras funções disponíveis na plataforma.

Basta substituir o e seguir as instruções do popup para finalizar a configuração e iniciar o monitoramento.Para saber mais sobre o cadastramento de credenciais e liberar acesso ao token, basta clique aqui.

No One Platform é possível gerar uma status page sobre suas aplicações e dependências cadastradas em seu produto digital.

Essa página é modular e personalizável de acordo com a sua necessidade, ou do seu cliente. Pode ser configurado quais aplicações e dependências deseja acompanhar de forma macro (apenas o status da aplicação no conjunto total) ou se prefere apresentar status de cada componente individual.

Você consegue cadastrar quantas status pages quiser, com diferentes componentes para determinada equipe, cliente ou objetivo.

Na página de status é possível acompanhar a atual situação da aplicação ou dependência, informando se está Operacional, Parcialmente Operacional ou Não Operacional junto com o tempo médio de resposta do respectivo componente. Auxiliando a entender se, além de estar operando com normalidade, o tempo que o componente está demorando para responder o usuário final.

Você pode também acompanhar, nos últimos 7 dias, se houve incidentes ocasionados em um determinado dia e seu atual status, deixando público se o incidente já foi resolvido ou se a situação permanece. São apresentados apenas incidentes das aplicações e dependências que estão configuradas para serem apresentadas.

Não são apresentadas métricas internas ou informações sensíveis de operação para equipe de engenharia e produto, podendo ser apenas acompanhadas na Matriz de Resiliência.

A ferramenta de status page é disponibilizada para uso de acordo com o seu plano do 1P. Caso não esteja liberada, converse com nosso atendente no chat.

Para criar uma status page, vá no menu lateral esquerdo e clique em Status Page.

Na tela seguinte, terá uma listagem de todas status pages já configuradas (caso tenha).

Para criar uma nova status page pública clique em NEW, no botão verde no canto superior à direita.

Irá abrir uma nova tela, de configuração da página. Nesta etapa você personaliza com nome, url e os componentes que serão apresentados nesta determinada status page.

Primeiro insira um nome que será apresentado na sua Status Page. Segue abaixo imagens comparativas de configuração e apresentação.

Por padrão, utilizamos o mesmo nome da página para criar o URL slug, porém pode ser personalizado como desejar. Não é obrigatório ter o nome e o slug iguais.

(configuração no 1P)

(apresentado na status page pública)

 

Abaixo do nome e slug, é apresentado os componentes da status page.

Os componentes são divididos e configurados por grupos, e dentro destes grupos são apresentadas as aplicações e dependências desejadas para cada separação.

Veja abaixo um modelo de como foi configurado no 1P e como fica a apresentação:

(configuração feita no 1P)

(apresentação dos componentes na status page)

 

Nesta etapa, temos dois blocos: My Resources x What will be shown in your Status Page.

O campo de My Resources apresenta seus produtos cadastrados no 1P, com os nomes pré-configurados nas páginas das aplicações.

Já o What will be shown in your Status Page, bom, é aquilo que será definitivamente apresentado e ficará público.

 

Clique em ADD Group e será posicionado um ícone de componente no bloco à direita. Dê um nome para o grupo no campo disponível, e arraste uma aplicação ou uma dependência para debaixo do nome criado.

Essa configuração funciona como drag-and-drop, ou seja, basta selecionar, arrastar os componentes de um bloco ao outro e soltar.

Após configurar como desejado, deve-se clicar em Save no fim da página.

Não é feito salvamento automático.

 

A URL pública da status page criada será gerada após executar os passos descritos acima e estará disponível logo abaixo o nome e o slug.

Serviços

Com nuvens, ambiente e serviços cadastrados, começa o monitoramento!

O cadastro dos serviços e dependências, pode ser realizado individualmente como iremos apresentar no passo a passo abaixo.

Ou pode ser realizado no momento do cadastro da aplicação, no qual você cadastra a aplicação e em seguida, na mesma página, adiciona dependências (serviços) e addOns. Os serviços cadastrados pela aplicação também ficam salvos no 1P, podendo utilizar o mesmo serviço para mais de uma aplicação.

Para saber sobre o cadastro de aplicação, clique aqui.

Dica: as mesmas informações solicitadas no cadastro individual, também são necessárias se o serviço for cadastrado via aplicação.

 

Segue abaixo o passo a passo para cadastramento de serviços individuais:

Clique em “Services” na barra lateral.

Um botão “NEW” vai aparecer, quase no cabeçalho da página. Clique nesse botão

Nesta etapa, será necessário:

Ao selecionar o campo de check type, mais configurações podem aparecer de acordo com a sua necessidade.

(Check type HTTP > method GET necessita configurar header e value)

(Check type HTTP > POST necessita configurar headers e post data com seus respectivos value, e selecionar o post-body type)

Você pode cadastrar serviços de acordo com a quantidade disponível no seu plano. Para saber mais sobre planos, clique aqui.

No cadastro de novos serviços dentro do Oneplatform o tipo de checagem para realizar o monitoramento é configurado através do campo “check type” e é selecionado um para cada tipo de serviço no seu ambiente.

Após a escolha do check type há a seleção do “method”.

Confira abaixo os tipo de checagem disponíveis:

  • DB (data base)
    • Postgres
    • MySQL
    • SQL Server
    • MongoDB
    • Oracle
    • Cassandra
    • Neo4j
  • Cache
    • Redis
    • Memcache
  • HTTP
    • GET
    • POST
  • Queue
    • Kafka
    • RabbitMQ
    • SQS
  • Lambda
    • AWS
  • Search Engine
    • Elastic Search
    • Solr
  • Outros
    • Ping
    • TCP

E você pode também monitorar via webhook.

Funcionalidade disponível junto às métricas da aplicação para monitoramento do desempenho e impacto de deploys.

O gráfico mostra o tempo de resposta entre o agente do 1P e a aplicação através da rota determinada pela health check URL. Apresentando também os deploys realizados na timeline, com o intuito de monitorar o impacto na aplicação após a mudança.

Apresenta os dados das últimas 24 horas como configuração padrão e no canto superior à direita é possível encontrar ferramentas para modificar a coleta de informações, como o intervalo da checagem e recortar alguma oscilação necessária para análise mais específica.

Saiba quais são as funcionalidades extras no gráfico de latência e deployments

Temos quatro funções básicas nessa funcionalidade: ajuste de zoom manual, ícone de movimentação, ajustar para zoom padrão e exportar as informações. Saiba mais sobre cada uma delas abaixo:

Selection Zoom: Com a função ativada é possível selecionar uma parte do gráfico e isolar um intervalo específico. Os botões de mais e menos são complementares e proporcionam um zoom geral do gráfico.

(ação selection zoom)

Panning: utilizada para seleção e movimentação horizontal do gráfico, para um intervalo a frente ou histórico passado.

(ação panning)

Reset Zoom: simbolizada com uma casa, serve para ajustar o zoom do gráfico ao padrão de last 24 hours. Basta clicar e o gráfico será ajustado automaticamente.

More: representado com 3 linhas, são ações de exportação das informações apresentadas no gráfico.

Você pode exportar o conjunto de dados nos formatos:

  • SVG
  • PNG
  • CSV

(ação de download)

Entenda sobre deployments no gráfico

Quando seu time de desenvolvimento lança uma alteração em algum serviço é extremamente necessário o monitoramento constante desta aplicação, para saber se houve melhora ou piora no seu desempenho.

Ao inserir um deploy dentro da aplicação do seu produto no 1P, temos o registro apresentado no gráfico do dia e hora em que foi realizada a alteração, assim identificando se houve impacto no tempo de resposta após o lançamento.

O registro de deploy fica gravado também na timeline da aplicação, junto com as notificações de incidentes.

Configuração

Depois de se inscrever na plataforma e definir a organização que deseja gerenciar, vamos configurar a nuvem e o ambiente.

Toda vez que acessar a página de entrada do One Platform irá visualizar a página de Produto. Para dar andamento à configuração, será preciso acessar o menu na barra latera.

 

Em primeiro lugar, será preciso definir os provedores de nuvem.

Clique em “Clouds” na barra lateral.

Um botão “NEW” vai aparecer, quase no cabeçalho da página. Clique nesse botão

Defina a nuvem por:

  • AWS
  • AZURE
  • Custom

(selecionando a nuvem)

 

Ao selecionar a nuvem que deseja definir, surgirão mais configurações de acordo com a sua necessidade.

(configuração para AWS Cloud)

(configuração para Azure Cloud)

 

Em seguida, dê um nome para a nuvem que está configurando. (Não precisa, necessariamente, ser o nome associado à nuvem do seu produto).

Você pode cadastrar os provedores de nuvem de acordo com a quantidade disponível no seu plano. Para saber mais sobre planos, clique aqui.

Depois de configurar o provedor de nuvem, temos que configurar os ambientes.

Clique em “Environments” na barra lateral.

Um botão “NEW” vai aparecer, quase no cabeçalho da página. Clique nesse botão

Nesta etapa, será necessário:

  • Definir um nome para o ambiente
  • Atribuir a um provedor de nuvem cadastrado no passo acima
  • Designar uma tag

(cadastro de novo ambiente)

 

Quando atribuir uma das nuvens cadastradas, aparecerão novas configurações de acordo com a necessidade da nuvem designada.

(configuração para AWS Cloud)

(configuração para Azure Cloud)

 

Dica: o ideal é que o nome e tag cadastrados sejam utilizados como no seu ambiente, para associação e comunicação com a One Platform.

Você pode cadastrar ambientes de acordo com a quantidade disponível no seu plano. Para saber mais sobre planos, clique aqui.

Com nuvens, ambiente e serviços cadastrados, começa o monitoramento!

O cadastro dos serviços e dependências, pode ser realizado individualmente como iremos apresentar no passo a passo abaixo.

Ou pode ser realizado no momento do cadastro da aplicação, no qual você cadastra a aplicação e em seguida, na mesma página, adiciona dependências (serviços) e addOns. Os serviços cadastrados pela aplicação também ficam salvos no 1P, podendo utilizar o mesmo serviço para mais de uma aplicação.

Para saber sobre o cadastro de aplicação, clique aqui.

Dica: as mesmas informações solicitadas no cadastro individual, também são necessárias se o serviço for cadastrado via aplicação.

 

Segue abaixo o passo a passo para cadastramento de serviços individuais:

Clique em “Services” na barra lateral.

Um botão “NEW” vai aparecer, quase no cabeçalho da página. Clique nesse botão

Nesta etapa, será necessário:

Ao selecionar o campo de check type, mais configurações podem aparecer de acordo com a sua necessidade.

(Check type HTTP > method GET necessita configurar header e value)

(Check type HTTP > POST necessita configurar headers e post data com seus respectivos value, e selecionar o post-body type)

Você pode cadastrar serviços de acordo com a quantidade disponível no seu plano. Para saber mais sobre planos, clique aqui.

É onde encontramos a Matriz de Resiliência com as informações geradas pela One Platform (1P).

Clique em “Products” na barra lateral.

Um botão “NEW” vai aparecer, quase no cabeçalho da página. Clique nesse botão

Nesta etapa, será necessário:

  • Inserir um nome
  • Campo para descrição
  • Selecione os teams que irão administrar o produto

Dica: o cadastro das equipes de trabalho (Teams) pode ser feito no cadastro do produto.

Após criar um produto, é necessário configurar as aplicações para finalizar a matriz de resiliência e iniciar o monitoramento.

Para inserir as aplicações dentro do seu produto, clique em “new resource” e então abrirá um pop up com 3 tipos de cadastro de aplicações, diferenciando o tipo de monitoramento que será feito:

Aplicação interna: Você precisa ter o agente instalado em sua nuvem. Você também pode adicionar dependências.

  • Agente requerido
  • Permitir dependências

Aplicativo externo com dependências: Você precisa ter o agente instalado em sua nuvem. Você também pode adicionar dependências.

  • Agente requerido
  • Permitir dependências

Monitoramento de aplicativos via webhook: Registramos ocorrências e falhas recebidas via webhook.

  • Sem agente
  • Sem dependências

Configurar Aplicação: Aplicação interna

Irá abrir um novo popup na tela atual. Nesta etapa, será necessário:

  • Escolher um ambiente
  • Inserir um nome a aplicação
  • Inserir healthcheck URL
  • Selecionar o método
  • Preencher ‘validations string’
  • Definir o intervalo e timeout (estão com configuração padrão, pode mudar se necessário)

Com essas configurações está disponível para criar uma aplicação para o produto cadastrado. São informações obrigatórias.

Ao selecionar o campo method, poderão surgir mais configurações de acordo com a sua necessidade.

Configurar Aplicação: Aplicativo externo com dependências

Irá abrir um popup na tela atual, semelhante a tela de cadastro de aplicações internas, como apresentado no tópico acima. Nesta etapa, será necessário configurar:

  • Escolher um ambiente
  • Inserir um nome a aplicação
  • Inserir healthcheck URL
  • Selecionar o método
  • Preencher ‘validations string’
  • Definir o intervalo e timeout (estão com configuração padrão, pode mudar se necessário)

O que é external monitoring e quando habilitar?

A função de external monitoring atua fazendo o monitoramento através de um agente externo (como se fosse um usuário sem acesso ao provedor da nuvem) para gerar os dados e a matriz de resiliência.

Configurar Aplicação: Monitoramento de aplicativos via webhook

O cadastro de aplicações monitoradas via webhook dentro do 1P é simples e rápido.

Nesta etapa será necessário:

  • Selecionar o Ambiente
  • Escolher um nome para aplicação que será utilizado para identificação no 1P

Após o cadastro da aplicação com monitoramento via webhook, você será direcionado a página de aplicação criada.

Clique em “Teams” na barra lateral.

Um botão “NEW” vai aparecer, quase no cabeçalho da página. Clique nesse botão

Nesta etapa, será necessário:

  • Inserir um nome
  • Escolher as formas de notificações para a equipe selecionada (será incluído o call rotation/escalation)

Como adicionar membros da equipe de trabalho na One Platform (1P)

Clique em “Users” na barra lateral.

Um botão “NEW” vai aparecer, quase no cabeçalho da página. Clique nesse botão

Nesta etapa, será necessário:

  • Endereço de email
  • Nome
  • Função

Descrição de cada função disponível:

  • Owner: esta função executa todas as ações em 1P, incluindo mudanças em nuvens, ambientes e usuários.
  • Admin: esta função será capaz de gerenciar produtos, serviços e dependências. Não tem acesso para modificar usuários, equipes, nuvens e ambientes.
  • Member: é um acesso somente à leitura. Não é capaz de modificar nenhuma configuração em 1P.

Após adicionar um usuário, é possível inseri-lo dentro de uma equipe para gerenciar o produto. Você pode cadastrar usuários de acordo com a quantidade disponível no seu plano. Para saber mais sobre planos, clique aqui.

A validação do número de telefone celular é necessária para habilitar diversas funções dentro do 1P, como integração de notificações via WhatsApp e funcionamento completo do Call Rotation, função para plantonistas e escalas alternadas de times.

Cada usuário deverá individualmente realizar a validação de telefone celular dentro da plataforma.

Clique em "Account" na barra lateral.

E você terá acesso a página com seus dados cadastrais. Preencha seu nome, coloque o número do seu telefone celular, depois clique em salvar.

O botão “Send verification code” vai ficar habilitado após salvar os dados cadastrais, antes disso estará desabilitado para validação.

Dica: o número de telefone celular cadastrado deve ser o mesmo utilizado para WhatsApp, ligações e sms.

 

Após salvar, clique no botão “send verification code” para receber o código de verificação via SMS.

Na página da plataforma irá aparecer uma caixa de mensagem solicitando o código de verificação de 4 dígitos.

Caso não receba, o re-envio do código de verificação pode ser feito através desta caixa de mensagem.

Em seguida receberá um SMS no seu aparelho celular com uma mensagem semelhante a abaixo:

Para finalizar, basta inserir os 4 dígitos que você recebeu via SMS em seu aparelho celular na caixa de mensagem.

Após finalizar todas as etapas, será apresentado em seus dados cadastrais a informação de “verified phone number” em verde para simbolizar que a validação foi realizada com sucesso.

O usuário na plataforma estará apto para utilizar de forma completa as funcionalidades de notificação e Call Rotation.

No One Platform é possível gerar uma status page sobre suas aplicações e dependências cadastradas em seu produto digital.

Essa página é modular e personalizável de acordo com a sua necessidade, ou do seu cliente. Pode ser configurado quais aplicações e dependências deseja acompanhar de forma macro (apenas o status da aplicação no conjunto total) ou se prefere apresentar status de cada componente individual.

Você consegue cadastrar quantas status pages quiser, com diferentes componentes para determinada equipe, cliente ou objetivo.

Na página de status é possível acompanhar a atual situação da aplicação ou dependência, informando se está Operacional, Parcialmente Operacional ou Não Operacional junto com o tempo médio de resposta do respectivo componente. Auxiliando a entender se, além de estar operando com normalidade, o tempo que o componente está demorando para responder o usuário final.

Você pode também acompanhar, nos últimos 7 dias, se houve incidentes ocasionados em um determinado dia e seu atual status, deixando público se o incidente já foi resolvido ou se a situação permanece. São apresentados apenas incidentes das aplicações e dependências que estão configuradas para serem apresentadas.

Não são apresentadas métricas internas ou informações sensíveis de operação para equipe de engenharia e produto, podendo ser apenas acompanhadas na Matriz de Resiliência.

A ferramenta de status page é disponibilizada para uso de acordo com o seu plano do 1P. Caso não esteja liberada, converse com nosso atendente no chat.

Para criar uma status page, vá no menu lateral esquerdo e clique em Status Page.

Na tela seguinte, terá uma listagem de todas status pages já configuradas (caso tenha).

Para criar uma nova status page pública clique em NEW, no botão verde no canto superior à direita.

Irá abrir uma nova tela, de configuração da página. Nesta etapa você personaliza com nome, url e os componentes que serão apresentados nesta determinada status page.

Primeiro insira um nome que será apresentado na sua Status Page. Segue abaixo imagens comparativas de configuração e apresentação.

Por padrão, utilizamos o mesmo nome da página para criar o URL slug, porém pode ser personalizado como desejar. Não é obrigatório ter o nome e o slug iguais.

(configuração no 1P)

(apresentado na status page pública)

 

Abaixo do nome e slug, é apresentado os componentes da status page.

Os componentes são divididos e configurados por grupos, e dentro destes grupos são apresentadas as aplicações e dependências desejadas para cada separação.

Veja abaixo um modelo de como foi configurado no 1P e como fica a apresentação:

(configuração feita no 1P)

(apresentação dos componentes na status page)

 

Nesta etapa, temos dois blocos: My Resources x What will be shown in your Status Page.

O campo de My Resources apresenta seus produtos cadastrados no 1P, com os nomes pré-configurados nas páginas das aplicações.

Já o What will be shown in your Status Page, bom, é aquilo que será definitivamente apresentado e ficará público.

 

Clique em ADD Group e será posicionado um ícone de componente no bloco à direita. Dê um nome para o grupo no campo disponível, e arraste uma aplicação ou uma dependência para debaixo do nome criado.

Essa configuração funciona como drag-and-drop, ou seja, basta selecionar, arrastar os componentes de um bloco ao outro e soltar.

Após configurar como desejado, deve-se clicar em Save no fim da página.

Não é feito salvamento automático.

 

A URL pública da status page criada será gerada após executar os passos descritos acima e estará disponível logo abaixo o nome e o slug.

Times

Clique em “Teams” na barra lateral.

Um botão “NEW” vai aparecer, quase no cabeçalho da página. Clique nesse botão

Nesta etapa, será necessário:

  • Inserir um nome
  • Escolher as formas de notificações para a equipe selecionada (será incluído o call rotation/escalation)

No campo de Teams dentro da plataforma, temos opções de canais de comunicação no qual desejam receber as referentes notificações que podem variar de time para time.

Pensando nisso, desenvolvemos também notificações via Telegram, para uma conversa privada ou um grupo.

Clique em “Teams” na barra lateral.

Caso deseje criar um novo time, basta clicar no botão “new” que aparece no canto superior esquerdo da tela.

Para times já cadastrados, basta acessar o time e ir na aba de notificações, na barra superior.

Selecione a opção que possui o ícone do Telegram, e insira o ID da conversa privada ou do grupo que deseja notificar.

Cada time pode ter apenas um telegram ID para notificações, contudo o mesmo telegram ID pode ser utilizado em outros time para centralização de notificações de acordo com a necessidade do seu time interno.

Se você precisa de ajuda para encontrar seu telegram ID, clique aqui.

O Telegram ID é diferente de cada conversa privada e também de grupos. Para saber onde buscar essa informação, acompanhe abaixo.

Em uma conversa privada

Acesse o aplicativo do telegram no seu smartphone.

Procure por “GlorfindelBot” no campo de busca:

Selecione a opção que estiver com o nome “1P” e com a logo do 1P como mostra na imagem superior, em seguida inicie uma conversa.

Digite o comando: /mychatid

Você receberá uma resposta similar a essa.

Modelo de exemplo: the chat_id is: XYZQKHRT

No qual, XYZQKHRT é o chat_id, é com esse código que OnePlatform conseguirá identificar em qual conversa quer receber as notificações.

Em um grupo

Você pode criar ou usar um grupo existente

Acesse o aplicativo do telegram no seu smartphone.

Procure por "GlorfindelBot" e o adicione ao grupo desejado

Digite o comando: /mychatid

Você receberá uma resposta similar a essa.

Modelo de exemplo:  the chat_id is: -XYZQKHRT

-XYZQKHRT é o chat_id, é com esse código que OnePlatform conseguirá identificar onde você quer receber as notificações.

O chat_id do grupo inicia com um traço, e não pode esquecer quando for adicionar no OnePlatform.

Na opção “Teams” dentro da plataforma, temos opções de canais de comunicação no qual desejam receber as referentes notificações que podem variar de time para time.

Pensando nisso, desenvolvemos também notificações via Slack, para uma conversa privada ou um canal.

Clique em “Teams” na barra lateral.

Caso deseje criar um novo time, basta clicar no botão “new” que aparece no canto superior esquerdo da tela.

Para times já cadastrados, basta acessar o time e ir na aba de notificações, na barra superior.

Selecione a opção que possui o ícone do Slack, e clique “install our slack app first”.

Abrirá uma janela com algumas configurações do Slack.

No canto superior à direita, você consegue selecionar qual o workplace que deve notificar. Em seguida você poderá ver quais são as execuções que serão permitidas, e, por último, selecionar qual canal ou conversa privada deseja enviar as notificações.

Clique em permitir, e será configurado automaticamente no 1P com o nome do workplace e do canal selecionados.

Após configuração realizada, basta clicar em salvar no fim das opções. Quando acontecer o primeiro incidente, a notificação será enviada via slack.

Na opção “Teams” dentro da plataforma, temos opções de canais de comunicação no qual desejam receber as referentes notificações que podem variar de time para time.

Pensando nisso, desenvolvemos também notificações via Microsoft Teams, para uma conversa privada ou um canal.

Clique em “Teams” na barra lateral.

Caso deseje criar um novo time, basta clicar no botão “new” que aparece no canto superior esquerdo da tela. 

Para times já cadastrados, basta acessar o time e ir na aba de notificações, na barra superior. Selecione a opção que possui o ícone do Microsoft Teams, e clique “Integration instructions”.

Abrirá um pop-up com direcionamentos para configurações dentro do Microsoft Teams.

Clique em “incoming webhook connector details” e em seguida abrirá uma nova guia no seu navegador da Microsoft.

É necessário estar cadastrado no Microsoft Teams para prosseguir com a configuração. Será solicitado que faça o login caso não acesse automaticamente.

Clique em “adicionar a uma equipe”, selecione o canal ou equipe e clique em configurar um conector.

Em seguida abrirá um pop-up na sua guia da Microsoft.

Insert the name “e.g. One Platform” in the field that is available, as shown in the image above.

Clique em criar.

Copie a URL gerada clicando em e em seguida clique em Concluído.

Caso a guia não feche automaticamente, você pode fechar a guia manualmente e voltar para a guia do OnePlaform, onde iniciamos a configuração.

Cole a URL copiada do passo anterior no campo “webhook url” disponível abaixo do item 2 e finalize clicando em “Done”.

Em seguida o campo necessário para a notificação via Microsoft Teams será preenchido automaticamente. 

Basta clicar em salvar e a configuração estará pronta.

 

Você receberá uma mensagem de confirmação no canal ou equipe escolhida para notificar no Microsoft Teams para garantir que a conexão foi realizada com sucesso.

Ampliando cada vez mais os canais de notificações, para melhorar a eficiência do seu time de desenvolvimento para avisos em caso de incidentes, agora você também pode habilitar notificações via Whatsapp.

Antes de iniciar o setup para os times, é necessário que os usuários cadastrados no time estejam com o número de telefone celular validado na plataforma. Caso não tenha, não receberá a notificação. 

Para fazer a validação de telefone celular, basta clique aqui.

Para configurar o Whatsapp como canal de notificação, basta seguir os passos abaixo:

Clique em “Teams” na barra lateral.

Selecione o time que irá receber os alertas via Whatsapp

Ao acessar as configurações do time selecionado, vá em Notificações na barra superior e habilite a opção “Send a notification to WhatsApp”. Após habilitar esta função, poderá selecionar quais integrantes do time serão notificados e em seguida clique em salvar.

O envio de notificações é feito apenas para contatos individuais, não tem opção de envio de notificações para grupos. Lembrando que somente usuários que estiverem com o número de celular validado poderão receber os alertas.

A funcionalidade de “Call Rotation” é designada para distribuição de notificações em casos de plantonistas, escalas de times e notificação via sms e ligação.

O Call Rotation é configurado por equipe. E será acionado em caso de incidente para todos os produtos que são monitorados pelo time determinado.

Funciona em paralelo com os canais de notificações pré-configurados na aba de “Notificações”; contudo, o Call Rotation é exclusivo para notificações via SMS e por chamada telefônica.

Antes de iniciar a configuração de escala do Call Rotation, é necessário que os usuários cadastrados no time estejam com o número de telefone celular validado na plataforma. Caso não estejam, não receberão a ligação ou SMS.

Para fazer a validação de telefone celular, basta clicar aqui..

Como configurar o Call Rotation

Como dito anteriormente, a funcionalidade de Call Rotation é configurada por time. Então precisa acessar o time para iniciar a configuração.

Segue abaixo todas as formas de acessar as configurações do time desejado.

Acesso ao time via Produto:

Clique em “Product” na barra lateral. E depois selecione o produto que tenha o time que deseja configurar.

Na barra superior, ao lado de “Availability”, onde mostra sua Matriz de Resiliência, há uma aba “Teams”. Selecione o time desejado nessa aba e você será redirecionado para a configuração do time.

Dica: caso você acesse o time através do Produto, não significa que será configurado escala de Call Rotation apenas para o Produto selecionado. A configuração é feita por time, e caso esse time esteja atribuído em outro produto, será inserido na escala de Call Rotation notificação de incidentes para os dois ou mais produtos. Este acesso é apenas para localizar o time desejado.

 

Acesso ao time via menu lateral:

Clique em “Teams” na barra lateral. E depois selecione o time que deseja configurar.

Na barra superior, selecione a aba com o nome de “Call Rotation” ao lado de “Notificações”

Lembrando: a escala de Call Rotation será configurada para todos os produtos monitorados por este time.

Entendendo as formas de montar a escala do seu time

A escala é criada a partir de “eventos” que podem ser determinados por dia, semana ou mês.

Você consegue criar um evento individual para um dia, clicando na data do calendário ao lado, e/ou segurando e arrastando o cursor do mouse desde a data de início, para a data de fim criando eventos com repetição.

Pode ser um dia, dois dias, quatro dias, uma semana completa, quinze dias ou todo o mês. Como for necessário de acordo com a demanda da sua equipe.

 

Após selecionada as datas desejadas, iremos completar as informações do evento. As informações a seguir serão sempre referente a um dia! Caso você tenha selecionado mais datas, o evento será repetido.

Resultando assim, em um evento com repetição diária, semanal ou mensal com as informações de um dia para o time. Semelhante ao Google Calendar.

 

Configurando o evento

Após seguir os passos e recomendações já descritas, sua página do OnePlatform estará semelhante a screenshot abaixo:

Adicione o horário de início e de término do time, de acordo com o horário diário. O formato de hora é de 24h. Caso a escala seja noturna, basta adicionar o horário correspondente à noite e à manhã que o sistema faz a distribuição automática do evento de um dia ao outro.

Step Group são as pessoas que serão responsáveis em responder por incidentes nesta escala. Basta selecionar qual grupo deseja atribuir as notificações.

Caso seja a primeira vez que está configurando o Call Rotation, é necessário criar um Step Group clicando no .

Para criar o Step Group: escolha primeiro colaborador da escala a ser notificado, selecione entre as opções de SMS ou Voice Call e configure o intervalo de tempo que será enviado o alerta e durante quanto tempo deverá alertado este primeiro colaborador até seguir o fluxo.

Adicione outro colaborador da escala em "add step", seguindo as mesmas configurações e opções de acionamento.

Dica: apenas estarão disponíveis os usuários com o número de telefone celular verificado. Caso o colaborador não apareça, é ele porque precisa verificar o número de telefone celular.

Dica: caso queira notificar o mesmo colaborador via SMS e Voice Call, basta adicioná-lo duplicado em sequência e selecionar um métodos de notificação para cada step.

A configuração do Step Group é individual para cada cliente e pode conter a quantidade de colaboradores necessários.

Imagem ilustrativa para apresentação de configuração de Step Group.

Para finalizar as configurações do Step Group, dê um nome para o fluxo criado e em seguida, clique em salvar.

Você também pode escolher a cor para diferenciar uma escala da outra, editar ou excluir o Step Group.

Este Step Group ficará salvo no Call Rotation para configurar mais eventos utilizando o mesmo fluxo.

 

Configuradas as datas, o horário e colaboradores para a escala, basta clicar em criar para cadastrar os eventos do Call Rotation.

Imagem ilustrativa do calendário após a criação dos eventos.

No campo de Teams dentro da plataforma, temos opções de canais para receber notificações de incidentes em diferentes plataformas de comunicação interna e externa.

Pensando nisso, desenvolvemos também notificações via Google Chat, para uma conversa privada ou um grupo.

 

Clique em “Teams” na barra lateral.

Caso deseje criar um novo time, basta clicar no botão “new” que aparece no canto superior esquerdo da tela.

Para times já cadastrados, basta acessar o time e ir na aba de notificações, na barra superior.

Selecione a caixa de seleção na opção que possui o ícone do Google Chat, e adicione o link de webhook disponibilizado na criação do bot na caixa de mensagens ao lado.

Depois basta clicar em salvar e está configurada notificações de incidentes via Google Chat.

Saiba como configurar um bot no Google Chat, clique aqui.

Vale lembrar, que o Google Chat é uma funcionalidade mais recente do Google e é diferente do Google Hangouts.

Para seguir com a configuração, você deve ter habilitado Google Chat na sua conta Google. 

Habilitar o Google Chat é simples, basta acessar o link ao lado https://mail.google.com/chat/u/0/ e será feito de forma automática. Caso não consiga, veja no link de suporte como habilitar na sua conta.

Link do suporte Google para Google Chat, clique aqui.

Configurando o bot em mensagens privadas ou grupos

Entre no Google Chat, na barra lateral à esquerda encontre a conversa que deseja criar o bot e clique na setinha ao lado do nome da conversa, .

 

Em seguida clique em “Gerenciar webhooks”. Irá abrir uma caixa de mensagem como na imagem abaixo.

Preencha o nome que será dado ao webhook e, caso tenha, uma URL com a imagem que será utilizada de avatar para o bot. Depois clique em salvar.

A caixa de mensagem será atualizada e o conector estará pronto para utilização, copie a URL clicando em .

Está URL é utilizada para o ativar o recebimento de notificações de incidente no seu time do OnePlatform, para saber como, basta clique aqui

Usuários

Como adicionar membros da equipe de trabalho na One Platform (1P)

Clique em “Users” na barra lateral.

Um botão “NEW” vai aparecer, quase no cabeçalho da página. Clique nesse botão

Nesta etapa, será necessário:

  • Endereço de email
  • Nome
  • Função

Descrição de cada função disponível:

  • Owner: esta função executa todas as ações em 1P, incluindo mudanças em nuvens, ambientes e usuários.
  • Admin: esta função será capaz de gerenciar produtos, serviços e dependências. Não tem acesso para modificar usuários, equipes, nuvens e ambientes.
  • Member: é um acesso somente à leitura. Não é capaz de modificar nenhuma configuração em 1P.

Após adicionar um usuário, é possível inseri-lo dentro de uma equipe para gerenciar o produto. Você pode cadastrar usuários de acordo com a quantidade disponível no seu plano. Para saber mais sobre planos, clique aqui.

Webhook

As credenciais de webhook tão determinadas por organização dentro do 1P e para acessar, basta clicar no nome da organização abaixo da sua foto de perfil no seu painel de usuário no menu lateral.

(neste caso, a organização é Elven Works)

 

Clique no botão simbolizado com um ícone de mais como na imagem abaixo.


Irá abrir uma caixa de mensagem onde você deve escolher o tipo de webhook que será cadastrado e dar um nome para identificar a sua credencial.

Clique no botão “generate integration token”. E aguarde o processamento da caixa de mensagem.

Credencial Hits/Failure

Após seguir os passos anteriores, em alguns segundos a sua credencial será criada e aparecerá semelhante a imagem abaixo:

(imagem ilustrativa, algumas informações podem variar)

 

Sua credencial está criada e pronta para o uso. Clique no ícone  para que o comando curl seja copiado para a sua área de transferência.

Seu token ficará registrado dentro da sua organização no 1P caso você precise consultar, editar ou remover.

 

Em seguida, você pode colar e em seguida executar o comando no seu terminal de sua preferência:

(imagem ilustrativa, algumas informações podem variar)

 

Será gerado o seu token para ativação da API, semelhante a imagem abaixo:

(imagem ilustrativa, algumas informações podem variar)

Credencial Deploy

Após seguir os passos descritos em “Criando as credenciais do Webhook”, sua caixa de mensagem fechará e sua página de credenciais será recarregada. Apresentando apenas o descritivo da credencial, como na imagem abaixo:

 

O token gerado pela credencial fica registrado na página da aplicação dentro do seu produto. E você terá um token para cada aplicação que deseja atualizar.

Editando as credenciais do Webhook

Acessando a sua lista de credenciais é possível editar um token já criado.

Clique no ícone representado por um lápis como na imagem abaixo para editar a credencial.

Após habilitar a edição, aparecerá uma caixa de mensagem apresentando o nome da credencial e o token atual.

Em seguida clique em “generate new token” e aguarde a plataforma gerar uma nova credencial.

Após a geração de uma nova credencial, é necessário refazer os passos anteriores de criação de credencial para executar o comando em qualquer terminal de sua preferência e obter o novo token.

ATENÇÃO

Após gerar uma nova credencial, o antigo token será invalidado.

Caso necessário, você também pode alterar o nome da credencial, porém novas credenciais serão geradas sempre que o nome é alterado.

Para excluir uma credencial clique no botão

Acesse a aplicação que deseja configurar o monitoramento, e clique no botão “Hits and Failures API”

Então abrirá um popup na tela onde contém as informações que serão utilizadas na comunicação entre o seu ambiente e o 1P, para análise de dados, desenvolvimento da matriz de resiliência, controle de incidentes e outras funções disponíveis na plataforma.

Basta substituir o e seguir as instruções do popup para finalizar a configuração e iniciar o monitoramento.Para saber mais sobre o cadastramento de credenciais e liberar acesso ao token, basta clique aqui.

Abaixo um exemplo de script para monitoramento simples, pressionando 1 ou 2 para enviar OK ou Falha.

O objetivo deste exemplo é somente demonstrar como devem ser feitas as chamadas para o webhook de monitoramento criado pelo 1P.

O script coleta as informações na sua aplicação ou dependência, interpreta o resultado e entrega para 1P de acordo com as instruções na caixa de “Hits and Failures” apresentada na página da sua aplicação cadastrada no OnePlatform.

Exemplo:

#!/bin/bash

echo "Falha ou OK?"
echo "1. Falha"
echo "2. OK"
read status
echo "-------------"

token=`curl --request POST \
        --url https://apis.elven.works/external/auth/v1/client/<Your Company URL> \
        --header 'Content-Type: application/json' \
        --data '{
          "client_id": "<YOUR INFORMATION HERE>",
          "client_secret": "<YOUR INFORMATION HERE>"
         }' | sed 's/{"access_token":"//g' | sed 's/","expires_in":300,"token_type":"Bearer"}//g'`


if [ $status == 2 ]; then
echo "OK"
curl -X POST -H 'Content-type: application/json' -H "Authorization: Bearer $token " https://apis.elven.works/external/monitoring/v1/hits --data '{"latency": 100000, "service": <YOUR SERVICE ID HERE>, "organization": "<YOUR ORGANIZATION ID HERE>"}'
fi

if [ $status == 1 ]; then
echo "Falha"
curl -X POST -H 'Content-type: application/json' -H "Authorization: Bearer $token " https://apis.elven.works/external/monitoring/v1/failures --data '{"issue": "<Your message>", "service": <YOUR SERVICE ID HERE>,"organization": "<YOUR ORGANIZATION ID HERE>"}'
fi

Indicado para Python 3 ou superior.

Abaixo um exemplo de script para monitoramento simples, pressionando 1 ou 2 para enviar OK ou Falha.

O objetivo deste exemplo é somente demonstrar como devem ser feitas as chamadas para o webhook de monitoramento criado pelo 1P.

Exemplo:

import requests

print(‘FAILURE OR OK?’)

print(‘TYPE 1 FOR FAILURE’)

print(‘TYPE 2 FOR OK’)

 

status = int(input(‘SELECT 1 OR 2:’))

 

choice = status

 

print(‘—‘, ‘the option to be performed is: ‘, choice, ‘—‘)

 

token_headers = {‘Content-Type’: ‘application/json’}

 

token_url = ‘https://apis.elven.works/external/auth/v1/client/<Your Company ID>

 

token_payload = {

    ‘client_id’: ‘<YOUR INFORMATION HERE>‘,

    ‘client_secret’: ‘<YOUR INFORMATION HERE>

}

 

req_token = requests.post(

    url=token_url,

    json=token_payload,

    headers=token_headers

)

 

token = req_token.json()[‘access_token’]

 

req_headers = {‘Content-Type’: ‘application/json’,

               ‘Authorization’: ‘Bearer ‘ + token}

 

req_url =  ‘https://apis.elven.works/external/auth/v1/client/<Your Company ID>

 

req_payload = {‘service’: <YOUR SERVICE ID HERE> ,

               ‘organization’: ‘<YOUR ORGANIZATION ID HERE>‘}

 

if (status == 2):

    print(“HITS”)

    hits_latency = {‘latency’: 100000}

    req_payload.update(hits_latency)

    hits = requests.post(

        url=req_url + ‘hits’,

        json=req_payload,

        headers=req_headers

    )

    print(req_payload)

    print(hits.json())

 

if (status == 1):

    print(“failures”)

    failures_issue = {‘issue’: ‘Error message’}

    req_payload.update(failures_issue)

    hits = requests.post(

        url=req_url + ‘failures’,

        json=req_payload,

        headers=req_headers

    )

    print(req_payload)

    print(hits.json())

Abaixo um exemplo de script para monitoramento simples, pressionando 1 ou 2 para enviar OK ou Falha.

O objetivo deste exemplo é somente demonstrar como devem ser feitas as chamadas para o webhook de monitoramento criado pelo 1P.

Exemplo:

Write-Output(“FAILURE OR OK?”)

Write-Output(“TYPE 1 FOR FAILURE”)

Write-Output(“TYPE 2 FOR OK”)

 

$status = Read-host “SELECT 1 OR 2 “

 

Write-Output(“—“,”the option to be performed is: “, $status, “—“)

 

$headers=@{}

$headers.Add(“content-type”, “application/json”)

$response = Invoke-WebRequest -Uri ‘https://apis.elven.works/external/auth/v1/client/<Your Company URL>’ `

                -Method POST `

                -Headers $headers `

                -ContentType ‘application/json’ `

                -Body ‘{“client_id”: “<YOUR INFORMATION HERE>”,”client_secret”: “<YOUR INFORMATION HERE>”}’

 

$StatusCode = $Response.StatusCode 

Write-Output “Get Token 1P – código resposta: $StatusCode” 

$token = ($response.Content | ConvertFrom-Json).access_token

  

$Date = Get-Date

$headers.Add(“authorization”, “Bearer $token”)

         

$invoke_headers =@{

    authorization = “Bearer $token”

}

$invoke_headers.Add(“content-type”, “application/json”)

 

if($status -eq 2)

{

  Write-Output(“HITS”)

  $HITS = Invoke-WebRequest -Uri ‘https://apis.elven.works/external/monitoring/v1/hits’ `

          -Method POST `

          -Headers $invoke_headers `

          -ContentType ‘application/json’ `

          -Body ‘{“latency”: 100000, “service”: <YOUR SERVICE ID HERE>, “organization”: “<YOUR ORGANIZATION ID HERE>”}’

  Write-Output(“$HITS”)

}

 

if($status -eq 1)

{

  Write-Output(“FAILURE”)

  $FAILURE = Invoke-WebRequest -Uri ‘https://apis.elven.works/external/monitoring/v1/failures’ `

             -Method POST `

             -Headers $invoke_headers `

             -ContentType ‘application/json’ `

             -Body ‘{“issue”: “ERROR MESSAGE”, “service”: <YOUR SERVICE ID HERE>, “organization”: “<YOUR ORGANIZATION ID HERE>”}’

  Write-Output($FAILURE)

}

Acessando a página da aplicação desejada, clique no ícone semelhante a esse: , logo abaixo do nome e informações sobre a aplicação.

Em seguida, abrirá uma caixa de mensagens, onde é possível:

  • Register in Timeline: para registrar o deploy de forma manual na timeline do gráfico de latência e implementação. Atualizando data e hora.
  • Deploy by Webhook: para registrar deploy na timeline no momento que for feita a atualização na aplicação. Sem necessidade de registro manual.

Neste caso, iremos realizar o deploy via webhook.

Ao clicar no botão “Deploy by Webhook” será apresentada uma nova caixa de mensagem, onde você deverá escolher a credencial já cadastrada na organização.

Ao selecionar a credencial desejada, sua caixa de mensagem será recarregada com o token referente a aplicação. Como na imagem abaixo:

Para inserir o deploy na timeline do gráfico de latência e implementações, basta utilizar o curl apresentado quando for efetuar a atualização na aplicação.

A descrição será registrada na timeline de incidentes como padrão “[nome da aplicação] is DEPLOYED”.

Elvenworks Soluções em tecnologia LTDA

Smart Platforms

 

pt_BR