Usando a API do Blob Storage para configurações do agente

O Blob Storage API é um serviço New Relic projetado para fazer upload e gerenciar arquivos na sua conta. NerdGraph é otimizado para consultas e mutações de dados estruturados, portanto, a API do Blob Storage é usada para operações que envolvem transferência e versionamento de conteúdo de arquivos.

Em Fleet Control, o Blob Storage API gerencia as configurações do agente — lidando com a criação, versionamento, recuperação de conteúdo e exclusão de arquivos de configuração.

Pré-requisitos

• Uma contaNew Relic com uma chave de API de usuário
• Seu New Relic Organization ID
• Devidas permissões para gerenciar configurações

Autenticação

Todas as requisições de API Blob Storage exigem autenticação usando uma chave de API de usuário New Relic.

Gere uma chave de API:

1. Acesse one.newrelic.com
2. Clique em seu nome no canto inferior esquerdo
3. Selecione API Keys
4. Crie uma chave de User (não uma chave de Browser ou de Licence)

Incluir nos cabeçalhos da requisição:

Api-Key: NRAK-YOUR-USER-API-KEY

Endpoint base

https://blob-api.service.newrelic.com/v1/e

Para contas da região da UE, use:

https://blob-api.service.eu.newrelic.com/v1/e

Operações de configuração do agente

POST /v1/e/organizations/{orgId}/AgentConfigurations

$
curl -X POST \
>
  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations \
>
  -H 'Api-Key: NRAK-YOUR-API-KEY' \
>
  -H 'Content-Type: application/x-yaml' \
>
  -H 'NewRelic-Entity: {"name": "Production Infra Config", "agentType": "NRInfra", "managedEntityType": "HOST"}' \
>
  -d 'license_key: YOUR_LICENSE_KEY
$
log:
$
  level: info
$
  forward: true
$
integrations:
$
  - name: nri-docker
$
    enabled: true'

{
  "entityGuid": "<YOUR_ENTITY_GUID>",
  "blobId": "<YOUR_BLOB_ID>",
  "blobVersionEntity": {
    "entityGuid": "<YOUR_ENTITY_GUID>",
    "version": 1
  }
}

POST /v1/e/organizations/{orgId}/AgentConfigurations/{parentConfigurationId}

$
curl -X POST \
>
  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations/<YOUR_ENTITY_GUID> \
>
  -H 'Api-Key: NRAK-YOUR-API-KEY' \
>
  -H 'Content-Type: application/x-yaml' \
>
  -d 'license_key: YOUR_LICENSE_KEY
$
log:
$
  level: debug
$
  forward: true
$
integrations:
$
  - name: nri-docker
$
    enabled: true
$
  - name: nri-nginx
$
    enabled: true'

{
  "entityGuid": "<YOUR_ENTITY_GUID>",
  "blobId": "<YOUR_BLOB_ID>",
  "blobVersionEntity": {
    "entityGuid": "<YOUR_ENTITY_GUID>",
    "version": 2
  }
}

GET /v1/e/organizations/{orgId}/AgentConfigurationVersions/{configurationVersionId}

GET /v1/e/organizations/{orgId}/AgentConfigurations/{configurationId}

$
curl -X GET \
>
  'https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurationVersions/<YOUR_ENTITY_GUID>' \
>
  -H 'Api-Key: NRAK-YOUR-API-KEY'

$
curl -X GET \
>
  'https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations/<YOUR_ENTITY_GUID>' \
>
  -H 'Api-Key: NRAK-YOUR-API-KEY'

license_key: YOUR_LICENSE_KEY
log:
  level: info
  forward: true
integrations:
  - name: nri-docker
    enabled: true

GET /v1/e/organizations/{orgId}/AgentConfigurations/{configurationId}/versions

$
curl -X GET \
>
  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations/<YOUR_ENTITY_GUID>/versions \
>
  -H 'Api-Key: NRAK-YOUR-API-KEY'

{
  "versions": [
    {
      "entity_guid": "<YOUR_ENTITY_GUID_1>",
      "blob_id": "<YOUR_BLOB_ID_1>",
      "version": "1",
      "timestamp": "2024-01-01T00:00:00Z"
    },
    {
      "entity_guid": "<YOUR_ENTITY_GUID_2>",
      "blob_id": "<YOUR_BLOB_ID_2>",
      "version": "2",
      "timestamp": "2024-01-02T00:00:00Z"
    }
  ],
  "cursor": null
}

DELETE /v1/e/organizations/{orgId}/AgentConfigurations/{configurationId}

$
curl -X DELETE \
>
  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations/<YOUR_ENTITY_GUID> \
>
  -H 'Api-Key: NRAK-YOUR-API-KEY'

DELETE /v1/e/organizations/{orgId}/AgentConfigurationVersions/{configVersionGuid}

$
curl -X DELETE \
>
  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurationVersions/<YOUR_ENTITY_GUID> \
>
  -H 'Api-Key: NRAK-YOUR-API-KEY'

Práticas medidas

• Armazene os GUIDs de entidade: Salve o entityGuid retornado das operações de criação. Você precisará deles para operações de versionamento, recuperação e exclusão.
• Versione incrementalmente: Crie novas versões para alterações de configuração em vez de excluir e recriar configurações.
• Use nomes descritivos: Os nomes de configuração devem indicar claramente seu propósito e ambiente de destino.
• Validar YAML: Certifique-se de que o conteúdo da sua configuração seja um YAML válido antes de fazer o upload.
• Verifique a compatibilidade do tipo de agente: Certifique-se de que o tipo de agente seja compatível com o tipo de entidade gerenciada (HOST ou KUBERNETESCLUSTER).
• Proteja sua chave de API: Nunca exponha sua chave de API de Usuário em código do lado do cliente ou repositórios públicos.
• Verifique os códigos de status HTTP: A API retorna 2xx para operações bem-sucedidas, 404 para não encontrado e outros códigos de status para erros.

Respostas de erro comuns

Recursos adicionais

• Tutorial do NerdGraph Fleet Control - Para gerenciar frotas e implantações
• Fleet Control CLI - Interface de linha de comando baseada nestas APIs
• Visão geral do Controle de Frota
• Chaves de API do New Relic