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.
Selecciona un pestaña para obtener instrucciones sobre cómo crear un cuadro en la página integraciones o Mercado.
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.
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.
Asegúrate de que estás dentro del directorio integrations-extras:
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.
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
Crea una rama de características en la que trabajar:
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:
Asegúrate de que estás dentro del directorio marketplace:
cd$HOME/dd/marketplace
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:
Asset Name
Asset Description
README
Includes an Overview, Setup, Data Collected (optional), and Support section using H2 headings (##) in Markdown.
Add any images and a video that you want to use for the integration tile’s media carousel in an images folder. You can add one video to each listing.
Technology Partners can use .png files instead of .jpg files to reduce image compression.
Media Carousel
Define the images you want to add to the integration tile’s media carousel in the media object specified in the tile definition on the manifest.json file.
Contains a list of out-of-the-box metrics included in the integration defined in the following format ending with a comma: metric_name,metric_type,interval,unit_name,per_unit_name,description, orientation,integration,short_name,curated_metric. The metadata.csv file is required for integrations only, not software licenses or professional services.
Provide the JSON files for out-of-the-box dashboards and monitors included in the integration in the dashboards and monitors folders nested in the assets directory.
For both dashboards and monitors, a title and description is required. Dashboards and monitors are required for integrations, not software licenses or professional services.
Technology Partners can create dashboards and monitors in a provisioned sandbox account, and export these assets into JSON files. For more information about dashboards, see Best Practices for Integration Preset Dashboards.
Logos
Add at least one SVG file which can be used in light and dark modes in a logos folder nested in the assets directory, or add the file(s) directly to the assets directory.
Technology Partners are responsible for the licensing of submitted logos.
Changelog
Document release notes and version information in the Changelog.md file using the following format: 1.0.0 / YYYY-MM-DD. This information is displayed in the Release Notes tab of the integration tile.
Technology Partners can add releases and version updates in descending order (latest version at the top).
CODEOWNERS
The CODEOWNERS file belongs in the shared .github directory and defines the individuals or teams responsible for maintaining the content and source code in the Marketplace repository.
Add the eula.pdf file in the assets directory for your Marketplace offering.
Technology Partners are responsible for adding the EULA.
LÉEME
Una vez creado el archivo README.md, añade las siguientes secciones como H2s (##) y rellena el contenido en consecuencia:
Nombre del encabezado
Encabezado
Información general
Escribe una descripción bajo un encabezado ## Overview que describa el valor y los beneficios que tu oferta proporciona a los usuarios, por ejemplo, dashboards, repeticiones de sesiones de usuario, logs, alertas disponibles de forma inmediata, y más.
Esta información se muestra en la pestaña Información general del cuadro.
Configuración
Incluye todos los pasos necesarios para configurar tu oferta que incluye información dividida en encabezados H3 (###). Los temas estándar incluyen:
- Instalar la integración utilizando el cuadro de integración en la aplicación. - Configurar la integración con las funciones y los permisos adecuados en tu organización Datadog. - Acceso a las funciones listas para utilizar de Datadog, a las que pueden acceder los usuarios que han adquirido e instalado la integración (como métricas, eventos, monitores, logs, dashboards, etc.).
Desinstalación
Incluye todos los pasos para desinstalar tu oferta. Esta información se muestra en la pestaña Configurar del cuadro.
Datos recopilados
Especifica los tipos de datos recopilados por tu integración (si procede), incluyendo métricas, eventos, checks de servicios y logs. Las métricas añadidas al archivo metadata.csv aparecen automáticamente en esta pestaña.
Si tu oferta no proporciona ninguno de estos datos, no es necesario que añadas una sección para datos recopilados.
Asistencia
Proporciona información de contacto a tu equipo de asistencia, que incluya una dirección de correo electrónico, un enlace a la documentación o a la entrada de blog de tu empresa e información adicional de ayuda en formato de lista con viñetas.
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/.
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:
Requisitos del vídeo
Descripción
Tipo
MP4 H.264
Tamaño
El tamaño máximo del vídeo debe ser de 1 GB.
Dimensiones
La proporción del aspecto debe ser exactamente 16:9 y la resolución debe ser 1920x1080 o superior.
Nombre
El nombre de archivo del vídeo debe ser partnerName-appName.mp4.
Duración del vídeo
La duración máxima del vídeo debe ser de 60 segundos.
Descripción
El número máximo de caracteres permitidos es 300.
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:
Requisitos de imagen
Descripción
Tipo
.jpg o .png.
Tamaño
El promedio es de unos 500 KB. El tamaño máximo de la imagen debe ser de 1 MB.
Dimensiones
La proporción del aspecto debe ser exactamente 16:9 y ajustarse a estas especificaciones:
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:
Confirma todos los cambios en tu rama de características.
Envía tus cambios al repositorio remoto.
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:
En GitHub, ve a tu repositorio bifurcado integrations-extras.
Haz clic en Sync fork (Sincronizar bifurcación) y en Update branch (Actualizar rama).
Para reorganizar y enviar cambios:
Actualiza tu rama local master:
git checkout master
git pull origin master
Combina master en tu rama de características:
git checkout <your working branch>
git merge master
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.
