Acceso programático a Fleet Control: API y CLI

Fleet Control proporciona un acceso programático integral a través de API y una interfaz de línea de comandos, lo que le permite automatizar las operaciones de la flota, integrarse con las herramientas existentes y gestionar su instrumentación a escala sin depender de la interfaz de usuario.

Opciones de acceso programático

Fleet Control ofrece tres métodos para el acceso programático:

• NerdGraph API: Para operaciones de gestión de flotas, incluyendo crear flotas, administrar miembros y controlar despliegues
• Blob Storage API: Para operaciones de configuración del agente, que incluyen la creación, el versionado y la recuperación de configuraciones
• Fleet Control CLI: Para la administración interactiva de la línea de comandos y scripts de automatización

Cuándo usar API vs. CLI

Comprender qué método de acceso se adapta mejor a su caso de uso le ayudará a trabajar de manera más eficiente con Fleet Control.

APIs (NerdGraph + Blob Storage API)

Las API son mejores para:

• Automatización e integración: Incorporar operaciones de Fleet Control en pipelines de CI/CD, herramientas personalizadas u otros flujos de trabajo automatizados
• Infraestructura como código: Gestionar las configuraciones de la flota junto con las definiciones de su infraestructura
• Integración entre sistemas: Conectar Fleet Control con otras plataformas, sistemas de tickets o herramientas de orquestación
• Flujos de trabajo complejos: Creación de automatización sofisticada que combina múltiples operaciones o se integra con fuentes de datos externas
• Acceso programático: Cuando necesite incorporar capacidades de Fleet Control en sus propias aplicaciones o servicios

Fleet Control CLI

La CLI es ideal para:

• Operaciones interactivas: Tareas rápidas dirigidas por humanos desde la línea de comandos
• Gestión ad hoc: Operaciones administrativas puntuales o solución de problemas
• Flujos de trabajo basados en la terminal: Si prefiere trabajar directamente en su terminal
• Pruebas locales: Experimentar con las operaciones de la flota antes de automatizarlas
• Scripts de shell: Operaciones secuenciales simples (aunque las API pueden ser mejores para la automatización compleja)
• Aprendizaje y exploración: La CLI proporciona retroalimentación inmediata y estructurada que le ayuda a comprender las operaciones de Fleet Control

La CLI está construida sobre las mismas API, por lo que funcionalmente proporcionan las mismas capacidades. La elección depende de la preferencia de interfaz y del caso de uso: la CLI para la interacción humana y la conveniencia, y las API para la integración programática y la automatización.

API de NerdGraph (Operaciones de flota)

NerdGraph es la API New Relic's GraphQL que proporciona acceso a las operaciones de Fleet Control para gestionar flotas, miembros y despliegues. A diferencia de las configuraciones del agente (que usan la API de Blob Storage), todas las operaciones a nivel de flota usan NerdGraph.

Qué puede hacer con el NerdGraph API

El NerdGraph API proporciona mutaciones para:

• Gestión de flotas: Crear, actualizar y eliminar flotas
• Gestión de miembros de la flota: Agregar y eliminar entidades administradas de los anillos de la flota
• Gestión de despliegues: Crear, actualizar, eliminar y desencadenar despliegues

Para obtener documentación completa, que incluye descripciones de parámetros, ejemplos de solicitud/respuesta y especificaciones detalladas de mutaciones, consulta el tutorial deNerdGraph Fleet Control .

Para explorar la API de forma interactiva, utilice el NerdGraph Explorer (o la región de la UE).

Para obtener información general sobre NerdGraph, consulte Introducción a NerdGraph.

Blob Storage API (configuraciones del agente)

El Blob Storage API es un servicio New Relic diseñado para cargar y administrar archivos. Fleet Control utiliza el Blob Storage API para administrar las configuraciones del agente, ya que NerdGraph está optimizado para consultas de datos estructurados en lugar de la transferencia eficiente de archivos. Esta API maneja todas las operaciones relacionadas con la configuración, incluyendo la creación de configuraciones, el versionado, la recuperación de contenido y la eliminación.

Qué puede hacer con la API de Blob Storage

La API de Blob Storage admite:

• Crear configuraciones de agente: Inicializar nuevas configuraciones con metadatos (nombre, tipo de agente, tipo de entidad administrada)
• Gestión de versiones: Crear nuevas versiones de configuraciones existentes
• Recuperar configuraciones: Obtener el contenido de la configuración por versión o la más reciente
• Operaciones de eliminación: Eliminar configuraciones o versiones específicas
• Listar versiones: Ver todas las versiones de una configuración con marcas de tiempo

Para obtener documentación completa, incluyendo ejemplos de curl, formatos de solicitud/respuesta, especificaciones de encabezados y tipos de agentes compatibles, consulte la Referencia de la API de Blob Storage - Guía completa con ejemplos de curl y detalles de los parámetros

La referencia de la API incluye ejemplos funcionales para todas las operaciones, requisitos de autenticación y mejores prácticas para gestionar las configuraciones del agente de forma programática.

Fleet Control CLI

El Fleet Control CLI es una interfaz de línea de comandos integral para gestionar todas las entidades de Fleet Control, incluyendo flotas, configuraciones, despliegues, miembros y consultas de entidades. La CLI proporciona un flujo de trabajo estructurado y basado en terminal tanto para operaciones interactivas como para automatización.

Jerarquía de comandos

Fleet Control los comandos están organizados por tipo de recurso para una navegación 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

Capacidades clave

El Fleet Control CLI le permite:

• Centralice las operaciones de los agentes: Instale, monitoree, configure y actualice todos los agentes e integraciones desde la línea de comandos
• Gestionar flotas: Agrupe las entidades por necesidades de instrumentación y actualice las versiones del agente para flotas completas
• Cree y versione configuraciones: Cree configuraciones de agentes y administre múltiples versiones
• Controle los despliegues: Cree, actualice y active despliegues con lanzamientos basados en anillos
• Consultar entidades: Liste las entidades gestionadas y no asignadas para comprender el panorama de su flota

Requisitos previos

Antes de usar los comandos de Fleet Control CLI, necesitará:

Variables de entorno requeridas:

$
# 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

Obtener sus credenciales:

1. Clave de API: Genere una clave de API de usuario desde one.newrelic.com → Haga clic en su nombre → API Keys → Create a "User" key
2. ID de cuenta: Busca tu ID de cuenta en la URL de New Relic después de /accounts/ o en la configuración de la cuenta
3. ID de la organización: La mayoría de los comandos aceptan un indicador --organization-id opcional. Si no se proporciona, la CLI obtendrá automáticamente el ID de su organización utilizando sus credenciales de API.

Documentación completa de la CLI

Para comenzar con el Fleet Control CLI, incluyendo la instalación y configuración, consulte el repositorio de la CLI de Fleet Control.

Para obtener una referencia detallada del comando Fleet Control, formatos de respuesta, reglas de validación y una guía de resolución de problemas, consulte el README de la CLI de Fleet Control.

La documentación de la CLI incluye:

• Referencia completa de comandos para todas las operaciones
• Especificaciones del formato de respuesta
• Trabajar con respuestas JSON usando jq
• Ejemplos prácticos de flujos de trabajo
• Reglas de validación y valores permitidos
• Solución de problemas comunes
• Sintaxis de flags y patrones de uso

Primeros pasos con el acceso programático

Para comenzar a usar Fleet Control de forma programática:

1. Generate a User API Key desde la configuración de tu cuenta de New Relic

2. Identifique su ID de cuenta y su ID de organización en la plataforma de New Relic

3. Seleccione su método de acceso:

   • Utilice el NerdGraph Explorer para explorar las operaciones de la flota de forma interactiva.
   • Revise las operaciones Blob Storage API para la gestión de la configuración
   • Instale y configure el Fleet Control CLI para flujos de trabajo basados en terminal

4. Comience con operaciones de lectura para familiarizarse con las estructuras de datos (buscar flotas, listar entidades, obtener configuraciones)

5. Construya la automatización gradualmente combinando operaciones en scripts o flujos de trabajo

Para obtener ayuda adicional con las API, consulta nuestra documentación de Introducción a NerdGraph y la documentación de claves de API.