Acesso programático ao Fleet Control: APIs e CLI

O Fleet Control oferece acesso programático abrangente por meio de APIs e de uma interface de linha de comando, permitindo automatizar as operações de frota, integrar-se às ferramentas existentes e gerenciar sua instrumentação em escala sem depender da interface do usuário.

Opções de acesso programático

Fleet Control oferece três métodos para acesso programático:

• NerdGraph API: Para operações de gerenciamento de frotas, incluindo criar frotas, gerenciar membros e controlar implantações
• Blob Storage API: Para operações de configuração do agente, incluindo criação, versionamento e recuperação de configurações
• Fleet Control CLI: Para gerenciamento interativo de linha de comando e scripts de automação

Quando usar APIs vs. CLI

Entender qual método de acesso melhor se adapta ao seu caso de uso ajudará você a trabalhar de forma mais eficiente com Fleet Control.

APIs (NerdGraph + Blob Storage API)

As APIs são melhores para:

• Automação e integração: Incorporar operações Fleet Control em pipelines CI/CD, ferramentas personalizadas ou outros fluxos de trabalho automatizados
• Infraestrutura como Código: Gerenciamento de configurações de frota juntamente com suas definições de infraestrutura
• Integração sistema a sistema: Conectando o Fleet Control a outras plataformas, sistemas de tickets ou ferramentas de orquestração
• Fluxos de trabalho complexos: Criação de automação sofisticada que combina múltiplas operações ou se integra a fontes de dados externas
• Acesso programático: Quando você precisa criar recursos de Fleet Control em seus próprios aplicativos ou serviços

Fleet Control CLI

A CLI é melhor para:

• Operações interativas: Tarefas rápidas, conduzidas por humanos, a partir da linha de comando
• Gerenciamento ad-hoc: Operações administrativas pontuais ou solução de problemas
• Fluxos de trabalho baseados em terminal: Se você prefere trabalhar diretamente no seu terminal
• Teste local: Experimentar operações de frota antes de automatizá-las
• Scripts de shell: Operações sequenciais simples (embora APIs possam ser melhores para automação complexa)
• Aprendizado e exploração: A CLI fornece feedback imediato e estruturado que ajuda você a entender as operações do Fleet Control

A CLI é construída sobre as mesmas APIs, portanto, funcionalmente, elas oferecem os mesmos recursos. A escolha é sobre preferência de interface e caso de uso: CLI para interação humana e conveniência, APIs para integração programática e automação.

API NerdGraph (Operações de frota)

NerdGraph é a API New Relic's GraphQL que fornece acesso às operações do Fleet Control para gerenciar frotas, membros e implantações. Ao contrário das configurações do agente (que usam a API de Blob Storage), todas as operações em nível de frota usam o NerdGraph.

O que você pode fazer com o NerdGraph API

O NerdGraph API fornece mutações para:

• Gerenciamento de frotas: Criar, atualizar e excluir frotas
• Gerenciamento de membros da frota: Adicionar e remover entidades gerenciadas dos anéis da frota
• Gerenciamento de deployments: Criar, atualizar, excluir e acionar deployments

Para documentação abrangente, incluindo descrições de parâmetros, exemplos de requisição/resposta e especificações detalhadas de mutação, consulte o tutorialNerdGraph Fleet Control .

Para explorar a API de forma interativa, use o NerdGraph Explorer (ou a região da UE).

Para informações gerais sobre NerdGraph, consulte Introdução ao NerdGraph.

Blob Storage API (configurações do agente)

O Blob Storage API é um serviço New Relic projetado para fazer upload e gerenciar arquivos. Fleet Control usa o Blob Storage API para gerenciar as configurações do agente, pois NerdGraph é otimizado para consultas de dados estruturados em vez de transferência eficiente de arquivos. Esta API gerencia todas as operações relacionadas a configurações, incluindo criação de configurações, versionamento, recuperação de conteúdo e exclusão.

O que você pode fazer com a API do Blob Storage

A API do Blob Storage suporta:

• Criar configurações de agente: Inicializar novas configurações com metadados (nome, tipo de agente, tipo de entidade gerenciada)
• Gerenciamento de versões: Criar novas versões de configurações existentes
• Recuperar configurações: Obter o conteúdo da configuração por versão ou a mais recente
• Operações de exclusão: Remover configurações ou versões específicas
• Listar versões: Visualizar todas as versões de uma configuração com timestamps

Para documentação abrangente, incluindo exemplos de curl, formatos de requisição/resposta, especificações de cabeçalho e tipos de agentes suportados, consulte a Referência da API de Blob Storage - Guia completo com exemplos de curl e detalhes de parâmetros

A referência da API inclui exemplos funcionais para todas as operações, requisitos de autenticação e práticas recomendadas para gerenciar configurações de agentes programaticamente.

Fleet Control CLI

O Fleet Control CLI é uma interface de linha de comando abrangente para gerenciar todas as entidades do Fleet Control, incluindo frotas, configurações, implantações, membros e consultas de entidade. A CLI fornece um fluxo de trabalho estruturado e baseado em terminal tanto para operações interativas quanto para automação.

Hierarquia de comandos

Fleet Control os comandos são organizados por tipo de recurso para navegação intuitiva:

newrelic fleetcontrol
├── fleet                    # Fleet management
│   ├── create              # Create a new fleet
│   ├── get                 # Get fleet details
│   ├── search              # Search fleets
│   ├── update              # Update fleet
│   ├── delete              # Delete fleet(s)
│   └── members             # Manage fleet members
│       ├── add             # Add entities to ring
│       ├── remove          # Remove entities from ring
│       └── list            # List fleet members
│
├── configuration            # Configuration management
│   ├── create              # Create configuration
│   ├── get                 # Get configuration content
│   ├── delete              # Delete configuration
│   └── versions            # Manage configuration versions
│       ├── list            # List all versions
│       ├── add             # Add new version
│       └── delete          # Delete specific version
│
├── deployment               # Deployment management
│   ├── create              # Create deployment
│   ├── update              # Update deployment
│   ├── deploy              # Trigger deployment
│   └── delete              # Delete deployment
│
└── entities                 # Entity queries
    ├── get-managed         # List managed entities
    └── get-unassigned      # List available entities

Principais capacidades

O Fleet Control CLI permite que você:

• Centralize as operações do agente: Instale, monitore, configure e atualize todos os agentes e integrações a partir da linha de comando
• Gerencie frotas: Agrupe entidades por necessidades de instrumentação e atualize as versões do agente para frotas inteiras
• Crie e versione configurações: Crie configurações do agente e gerencie múltiplas versões
• Controle implantações: Crie, atualize e acione implantações com rollouts baseados em anéis
• Consultar entidades: Liste entidades gerenciadas e não atribuídas para entender o panorama da sua frota

Pré-requisitos

Antes de usar os comandos do Fleet Control CLI, você precisará de:

Variáveis de ambiente obrigatórias:

$
# Your New Relic User API Key
$
export NEW_RELIC_API_KEY="NRAK-YOUR-API-KEY-HERE"
$

$
# Your New Relic Account ID
$
export NEW_RELIC_ACCOUNT_ID="your-account-id"
$

$
# Optional: Specify region (defaults to US)
$
export NEW_RELIC_REGION="US"  # or "EU" for European accounts

Obtendo suas credenciais:

1. Chave de API: Gere uma chave de API de usuário no one.newrelic.com → Clique no seu nome → API Keys → Create a "User" key
2. ID da conta: Encontre o ID da sua conta na URL do New Relic após /accounts/ ou nas configurações da conta
3. ID da organização: A maioria dos comandos aceita uma flag --organization-id opcional. Se não fornecido, a CLI buscará automaticamente o ID da sua organização usando suas credenciais de API.

Documentação completa da CLI

Para começar a usar o Fleet Control CLI incluindo instalação e configuração, consulte o repositório da CLI do Fleet Control.

Para obter uma referência detalhada do comando Fleet Control, formatos de resposta, regras de validação e orientações de solução de problemas, consulte o README da CLI do Fleet Control.

A documentação da CLI inclui:

• Referência completa de comandos para todas as operações
• Especificações do formato de resposta
• Trabalhando com respostas JSON usando jq
• Exemplos práticos de fluxo de trabalho
• Regras de validação e valores permitidos
• Solução de problemas comuns
• Sintaxe da flag e padrões de uso

Primeiros passos com acesso programático

Para começar a usar Fleet Control programaticamente:

1. Generate a User API Key nas configurações da sua conta New Relic

2. Identifique seu ID da conta e ID da organização na plataforma New Relic

3. Escolha o método de acesso:

   • Use o NerdGraph Explorer para explorar as operações de frota de forma interativa
   • Revise as operações Blob Storage API para gerenciamento de configuração
   • Instale e configure o Fleet Control CLI para fluxos de trabalho baseados em terminal

4. Comece com operações de leitura para se familiarizar com as estruturas de dados (pesquisar frotas, listar entidades, obter configurações)

5. Construa a automação gradualmente combinando operações em scripts ou fluxos de trabalho

Para obter ajuda adicional com APIs, consulte nossa documentação de Introdução ao NerdGraph e a documentação de chaves de API.