Información general

Esta página guía a los socios tecnológicos a través de la creación del cuadro que representa una oferta que aparecerá en la página Integraciones o Marketplace.

Cuadro de integración

Este cuadro sirve como punto de entrada donde los clientes pueden conocer tu oferta, ver instrucciones de configuración e instalar o comprar tu oferta para desbloquear dashboards y recursos adicionales, disponibles de forma inmediata.

• Para cualquier oferta que no utilice el Datadog Agent, incluyendo las integraciones basadas en la API, los listados de servicios profesionales y las licencias de software, sólo necesitas crear un cuadro y enviar los archivos relacionados con el cuadro para publicar tu oferta. Esto se conoce como listado sólo de cuadros. Los listados sólo de cuadros se aplican en las situaciones en que Datadog no aloja ningún código asociado con integraciones basadas en la API y en que los otros tipos de ofertas admitidos no requieren ningún código.

• Para las integraciones basadas en el Agent, debes crear un cuadro y, además, debes enviar todo tu código relacionado con integraciones (así como tus archivos relacionados con el cuadro) en una solicitud pull. Para obtener más información, consulta Crear una integración basada en el Agent.

Para crear un cuadro en la página Integraciones:

Si ya has seguido los pasos para crear una integración del Agent y has construido el andamiaje, puedes pasar directamente a completar los archivos de recursos de integraciones necesarios.

1. Crea un directorio dd:

   mkdir $HOME/dd
   

   El conjunto de herramientas de desarrollo de Datadog supone que trabajarás en el directorio $HOME/dd/. Esto no es obligatorio, pero trabajar en un directorio diferente requiere pasos de configuración adicionales.

2. Bifurcación del repositorio integrations-extras.

3. Clona el repositorio integrations-extras:

   git clone git@github.com:DataDog/integrations-extras.git
   

Instalar y configurar el conjunto de herramientas de desarrollo de Datadog

La herramienta para desarrolladores de integraciones del Agent te permite construir un andamiaje cuando estás desarrollando una integración, generando un esqueleto de los recursos y metadatos de tu cuadro de integraciones. Para obtener instrucciones sobre la instalación de la herramienta, consulta Instalar la herramienta para desarrolladores de integraciones del Datadog Agent.

Una vez que hayas instalado la herramienta para desarrolladores de integraciones del Agent, configúrala para el repositorio integrations-extras.

Configura integrations-extras como el repositorio de trabajo por defecto:

ddev config set extras $HOME/dd/integrations-extras
ddev config set repo extras

Si has utilizado un directorio distinto de $HOME/dd para clonar el directorio integrations-extras, utiliza el siguiente comando para configurar tu repositorio de trabajo:

ddev config set extras <PATH/TO/INTEGRATIONS_EXTRAS>
ddev config set repo extras

Rellenar el andamiaje del cuadro de integración

Para las integraciones de la API de Datadog que estarán disponibles de forma inmediata en la página Integraciones , utiliza el conjunto de herramientas para desarrolladores de Datadog para construir un andamiaje para un listado exclusivo de cuadro.

1. Asegúrate de que estás dentro del directorio integrations-extras:

   cd $HOME/dd/integrations-extras
   

2. Ejecuta el comando ddev con la opción -t tile:

   ddev create -t tile "<Offering Name>"
   

Para crear un cuadro en la página Mercado:

Si ya has seguido los pasos para crear una integración del Agent y has construido el andamiaje, puedes pasar directamente a completar los archivos de recursos de integraciones necesarios.

1. Consulta Crear una oferta de Marketplace para solicitar acceso al repositorio de Mercado.

2. Crea un directorio dd:

   mkdir $HOME/dd
   

   El comando del conjunto de herramientas para desarrolladores de Datadog supone que trabajarás en el directorio $HOME/dd/. Esto no es obligatorio, pero trabajar en un directorio diferente requiere pasos de configuración adicionales.

3. Una vez que se te haya concedido acceso al repositorio de Mercado, crea el directorio dd y clona el repositorio marketplace:

   git clone git@github.com:DataDog/marketplace.git
   

4. Crea una rama de características en la que trabajar:

   git switch -c <YOUR INTEGRATION NAME> origin/master
   

Instalar y configurar el conjunto de herramientas de desarrollo de Datadog

La herramienta para desarrolladores de integraciones del Agent te permite construir un andamiaje cuando estás desarrollando una integración, generando un esqueleto de los recursos y metadatos de tu cuadro de integraciones. Para obtener instrucciones sobre la instalación de la herramienta, consulta Instalar la herramienta para desarrolladores de integraciones del Datadog Agent.

Una vez que hayas instalado la herramienta para desarrolladores de integraciones del Agent, configúrala para el repositorio marketplace.

Configura marketplace como el repositorio de trabajo por defecto:

ddev config set marketplace $HOME/dd/marketplace
ddev config set repo marketplace

Si has utilizado un directorio distinto de $HOME/dd para clonar el directorio marketplace, utiliza el siguiente comando para configurar tu repositorio de trabajo:

ddev config set marketplace <PATH/TO/MARKETPLACE>
ddev config set repo marketplace

Rellenar el andamiaje del cuadro de integración

Utiliza el conjunto de herramientas de desarrollo de Datadog para construir un andamiaje para un listado exclusivo de cuadro.

Para crear el andamiaje de listado exclusivo de cuadro:

1. Asegúrate de que estás dentro del directorio marketplace:

   cd $HOME/dd/marketplace
   

2. Ejecuta el comando ddev con la opción -t tile:

   ddev create -t tile "<Offering Name>"
   

Completar los archivos de recursos de integraciones necesarios

Asegúrate de que los siguientes recursos necesarios para tu integración están completos:

LÉEME

Una vez creado el archivo README.md, añade las siguientes secciones como H2s (##) y rellena el contenido en consecuencia:

Cuando añadas enlaces al archivo README.md, formatéalos utilizando enlaces de estilo referencia. Por ejemplo, en lugar de insertar la URL directamente en el texto, escribe see the [official Datadog documentation][1] y define la referencia del enlace al final del archivo, como por ejemplo [1]: https://docs.datadoghq.com/.

Para ver más consejos de gramática y estilo, consulte también la documentación de Datadog con directrices para colaboradores.

Carrusel multimedia

En cada cuadro se muestra un carrusel multimedia de imágenes y un vídeo, lo que permite a los usuarios comprender mejor la funcionalidad y el valor de tu oferta a través de ayudas visuales. Para añadir un vídeo a tu cuadro, envía una copia o un enlace de descarga de tu vídeo a marketplace@datadoghq.com. El equipo de Marketplace carga el vídeo y proporciona un vimeo_link que debe añadirse al archivo manifest.json.

Vídeo

El vídeo debe cumplir los siguientes requisitos:

Imágenes

Los socios tecnológicos pueden añadir hasta ocho imágenes (siete, si incluye vídeo) en el carrusel multimedia del cuadro.

Las imágenes deben cumplir los siguientes requisitos:

Sigue esta plantilla para definir el objeto media en el archivo manifest.json que incluye una imagen, una miniatura del vídeo y un vídeo:

"media": [
      {
        "media_type": "image",
        "caption": "A Datadog Marketplace Integration OOTB Dashboard",
        "image_url": "images/integration_name_image_name.png"
      },
      {
        "media_type": "video",
        "caption": "A Datadog Marketplace Integration Overview Video",
        "image_url": "images/integration_name_video_thumbnail.png",
        "vimeo_id": 123456789
      },
    ],

Para obtener más información, consulta Referencia de recursos de integraciones.

Abrir una solicitud pull

Antes de abrir una solicitud pull, ejecuta el siguiente comando para detectar cualquier problema en tu integración:

ddev validate all <INTEGRATION_NAME>

Completa los siguientes pasos:

1. Confirma todos los cambios en tu rama de características.
2. Envía tus cambios al repositorio remoto.
3. Abre una solicitud pull que contenga tus archivos de recursos del cuadro de integración (incluidas las imágenes) en el repositorio marketplace o integrations-extras.

Después de crear tu solicitud pull, automáticamente se ejecutan checks para verificar que tu solicitud pull está en buen estado y que contiene todo el contenido necesario para la actualización.

Proceso de revisión

Una vez que tu solicitud pull pasa todos los checks, los revisores de los equipos Datadog/agent-integrations, Datadog/ecosystems-review y Datadog/documentation brindan sugerencias y comentarios sobre las prácticas recomendadas.

Una vez que hayas respondido a los comentarios y hayas vuelto a solicitar revisiones, estos revisores aprobarán tu solicitud pull. Ponte en contacto con el equipo de Marketplace, si quieres obtener una vista previa del cuadro en tu cuenta sandbox. Esto te permite previsualizar y validar tu cuadro antes de que se publique para todos los clientes.

Solucionar errores

Las integraciones del repositorio integrations-extras disponibles de forma inmediata pueden encontrarse con errores de validación cuando el repositorio bifurcado no está actualizado con el origen.

Para resolver los errores de validación, actualiza el repositorio bifurcado en la web de GitHub:

1. En GitHub, ve a tu repositorio bifurcado integrations-extras.
2. Haz clic en Sync fork (Sincronizar bifurcación) y en Update branch (Actualizar rama).

Para reorganizar y enviar cambios:

1. Actualiza tu rama local master:

   git checkout master
   git pull origin master
   

2. Combina master en tu rama de características:

   git checkout <your working branch>
   git merge master
   

3. Si hay algún conflicto de combinación, resuélvelo. A continuación, ejecuta git push origin <your working branch>.

Oportunidades de comercialización (GTM)

Datadog ofrece compatibilidad con GTM sólo para los anuncios de Marketplace. Para obtener más información sobre Datadog Marketplace, consulte Crear una oferta de Marketplace.

Leer más

Additional helpful documentation, links, and articles:

Extender el alcance de tu monitorización en el mercado de DatadogBLOG Crear una oferta en el mercado de DatadogDOCUMENTACIÓN