Notebooks

Resumen

Los Notebooks son documentos colaborativos de texto enriquecido que te brindan todo el poder de los gráficos de Datadog. Múltiples usuarios pueden trabajar juntos para realizar una investigación o postmortem con datos en vivo de tu incidente. Los Notebooks también son excelentes para runbooks y documentación que presentan información real sobre tus sistemas junto a tu contenido.

Creando un notebook

Puedes crear un notebook en dos lugares:

  • Desde la barra de navegación izquierda, haz clic en Dashboards > New Notebook.
  • En la esquina superior derecha de la página de Notebooks List page, haz clic en New Notebook.

Plantillas de Notebook

En la Galería de Plantillas, consulta plantillas listas para usar de las cuales puedes crear nuevos Notebooks. Las plantillas incluyen un postmortem de Respuesta a Incidentes, un Informe de Incidentes y Especificación de Service Level Objectives. También puedes crear una nueva plantilla personalizada para construir estructuras reutilizables de Notebooks.

Editando un Notebook

Los Notebooks ofrecen una experiencia de edición de texto enriquecido para crear y colaborar en contenido. Puedes escribir y dar formato al texto libremente utilizando opciones de barra de herramientas familiares y atajos de teclado, como negrita, cursiva, encabezados, listas y más, directamente en el editor.

Para los usuarios que prefieren atajos, los Notebooks también soportan la sintaxis Markdown. Por ejemplo, escribir # seguido de un espacio crea un encabezado, y usar tres comillas invertidas ("```) inicia un bloque de código.

El contenido de texto se guarda automáticamente a medida que escribes. Para gráficos incrustados, asegúrate de guardar tus cambios en el editor de gráficos para aplicarlos dentro del notebook.

Tipos de contenido

Los notebooks soportan varios tipos de contenido enriquecido e incrustado, incluyendo, pero no limitado a:

  • Gráficos
  • Imágenes
  • Encabezados (H1 - H3)
  • Listas (listas con viñetas, listas numeradas y listas de verificación)
  • Bloques de código
  • Citas en bloque
  • Celdas de Markdown

Para la lista completa, escribe / en un Notebook.

Gráficas en Notebooks

Notebooks soportan todos los tipos de widgets. Para la lista completa, consulta Widgets.

Pasa el cursor sobre el widget para mostrar opciones de edición y configuración de gráficos.

Para editar la consulta o configurar la visualización de la gráfica, utiliza la función Quick Edit para realizar la mayoría de los cambios en línea. Para una configuración más avanzada, haz clic en el ícono de lápiz o mantén presionada la tecla Cmd/Ctrl y haz clic en el gráfico para abrir el editor de gráficos completo. Puedes ajustar el marco de tiempo local o vincular el gráfico al tiempo global del Notebook haciendo clic en el ícono de reloj.

Opciones adicionales de configuración de gráficos son accesibles bajo el menú de elipsis de tres puntos, dependiendo del tipo de gráfico:

  • Tamaño del gráfico: Ajusta la altura del gráfico seleccionando XS, S, M (predeterminado), L o XL.
  • Leyenda del gráfico: Desmarca la casilla para ocultar la leyenda. Las leyendas están automáticamente deshabilitadas para gráficos XS y S.

Características de texto enriquecido

Notebooks soportan características de texto enriquecido comúnmente utilizadas como negritas, cursivas, código en línea y encabezados. Notebooks también soportan una variedad de tipos de listas como listas con viñetas, numeradas o de verificación.

CaracterísticaDescripción
NegritaPara poner texto en negrita, selecciónalo y presiona Cmd/Ctrl + B.
CursivasPara poner texto en cursiva, selecciónalo y presiona Cmd/Ctrl + I.
Inline codePara código en línea, escribe ` al principio y al final del texto.
Bloques de códigoInserta un bloque de código escribiendo ``` y presionando Enter, o utilizando el menú de comandos con barra.
CitasInserta un bloque de cita escribiendo >, o utilizando el menú de comandos con barra.
Tablas de textoInserta una tabla escribiendo /table o usando el menú Add Cell.
LlamadasInserta una llamada escribiendo /table o escribiendo !NOTE, !TIP, !WARNING, !IMPORTANT, o !CAUTION y luego presionando Espacio.

Smart chips

CaracterísticaDescripción
@MentionPara mencionar a otro usuario, escribe @ seguido de su nombre o dirección de correo electrónico.
$TemplateVariableEscribe $ seguido del nombre de tu variable de plantilla existente.
/dateAgrega un chip de fecha escribiendo /date. Puedes editar la fecha o la hora en el popover cada vez que haces clic en el chip. ¡También prueba /today y /now!

Slash commands

Los Slash commands son una interfaz para crear gráficos o insertar otro contenido. En una nueva línea, escribe / para abrir el slash command menu. Continúa escribiendo el nombre del tipo de contenido deseado y selecciona la opción apropiada.

Slash command menu que aparece cuando escribes / en un Notebook.

Cuando seleccionas un tipo de gráfico, se abre el editor de gráficos. Después de hacer clic en Save, el gráfico aparece en tu Notebook.

Atajos de teclado

Menú de atajos de teclado para Notebooks de Datadog.

En la esquina inferior izquierda de un Notebook, haz clic en el ícono de teclado para ver una lista de atajos de teclado para editar.

Además, puedes usar los siguientes atajos para cortar y pegar widgets (Cmd/Ctrl + X, Cmd/Ctrl + V).

Tabla de contenidos

Los Notebooks generan automáticamente una tabla de contenidos a partir de cualquier encabezado o gráfico que insertes en tu documento. Puedes crear un encabezado usando el atajo de markdown # o seleccionando texto y haciendo clic en Header en la barra de herramientas.

Notebook tags

Opciones de Notebook tags para marcar un Notebook como favorito, agregar un equipo o agregar un tipo.
Tag actionDescription
Marcar un Notebook como favoritoMarcar un Notebook como favorito para fijarlo en la parte superior de tus resultados en la página de la lista de Notebooks. Para alternar un Notebook como favorito, haz clic en el ícono de estrella en el encabezado del Notebook.
Etiquetar por equipoEtiquetar un Notebook con un equipo te permite usarlo como un filtro al buscar un Notebook. Puedes etiquetar un Notebook con hasta 5 equipos. Para etiquetar un Notebook, haz clic en la opción Team en el encabezado del Notebook y selecciona los equipos deseados.
Tag by TypePuedes etiquetar tus Notebooks con etiquetas de tipo para facilitar la búsqueda, tales como: Postmortem, Runbook, Investigation, Documentation, Report. Para etiquetar un Notebook, haz clic en Type y selecciona un tipo.

Agregar imágenes a los notebooks

Solo se admiten tipos de archivo PNG, JPG, JPEG y GIF. Las cargas tienen un tamaño máximo de archivo de 4MB.

Puedes agregar imágenes a tu notebook usando /image o el menú Agregar celda. Esto proporciona opciones para cambiar el tamaño, alinear y subtitular la imagen. Las imágenes cargadas se alojan en Datadog.

Puedes usar cualquiera de las siguientes opciones para cargar una imagen que será alojada por Datadog:

  • Suelta un archivo de imagen en el área de carga
  • Haz clic en Elegir archivo y localiza la imagen en tu directorio de archivos
  • Pega una URL accesible públicamente para la imagen

Haz clic en los íconos en la bandeja de acciones de la imagen para ajustar el tamaño, la alineación, agregar un pie de foto o ver la imagen en pantalla completa.

Agregar comentarios a un notebook

Puedes agregar comentarios sobre el contenido en el cuerpo del notebook. Para comentar sobre un texto, resalta el texto y haz clic en el ícono de comentario en la barra de herramientas.

Para comentar sobre un gráfico o una imagen, haga clic en el ícono de comentario a la derecha del gráfico.

CaracterísticaDescripción
Navegando a ComentariosLos comentarios guardados aparecen en el margen derecho del notebook. Haz clic en un comentario resaltado en el texto para abrirlo en el margen, o haz clic en un comentario en el margen para desplazarte a su ubicación.
Responde a los comentarios haciendo clic en ellos en el margen derecho, lo que abre un cuadro de comentario.Puedes escribir texto, @mention un usuario de Datadog, o resolver un comentario haciendo clic en Resolver.
Enlazando a ComentariosEnlace a un comentario específico haciendo clic en el ícono de enlace en la esquina superior derecha del comentario para copiar su enlace.
Editando o Eliminando ComentariosEdita o elimina tus comentarios haciendo clic en el menú de elipsis de tres puntos en la esquina superior derecha del comentario.
Por defecto, se envían notificaciones por correo electrónico al autor del notebook por nuevos comentarios de otros.Los usuarios en un hilo de comentarios reciben notificaciones por cada respuesta. Para ajustar las notificaciones, en el menú de engranaje, selecciona Notificaciones.

Experiencia multijugador en Notebooks

Notebooks soportan colaboración completa, permitiendo que múltiples usuarios editen simultáneamente. Cuando un colaborador abre tu notebook, su cursor aparece en tiempo real. Pasa el cursor sobre el indicador para ver el nombre del colaborador.

Widgets

Cuando otro usuario está editando un widget, aparece un contorno alrededor del widget. Dado que los widgets se guardan como el último en escribir, evita editar un widget en el que alguien más esté trabajando.

Presencia

En la parte superior del notebook, puedes ver los avatares de todos los usuarios que están viendo el notebook. Pasa el cursor sobre un avatar para ver el nombre del colaborador asociado.

Configurando un notebook

Variables de plantilla

Los Notebooks soportan variables de plantilla. Establece de manera dinámica el alcance de las visualizaciones al agregar y seleccionar valores para las variables de plantilla. Para más información, consulta Variables de Plantilla.

Algunas características de Análisis tienen soporte limitado o nulo para variables de plantilla. Para más información, consulta Soporte de Variables de Plantilla en Cuadernos de Análisis.

Controles de tiempo

Por defecto, todos los gráficos están vinculados al marco de tiempo global establecido en el encabezado del notebook.

Para ver un marco de tiempo diferente, selecciona una opción en el selector de tiempo global, o desliza sobre un gráfico directamente. La URL del notebook se actualiza para reflejar este nuevo marco de tiempo sin guardarlo en el notebook.

Nota: Hacer clic y arrastrar para acercar un gráfico no desvincula el gráfico del tiempo global. En su lugar, cambia el tiempo global del cuaderno.

Para guardar este tiempo como el predeterminado del notebook, haz clic en Establecer Tiempo Predeterminado. Para restablecer tu tiempo global a la configuración predeterminada guardada anteriormente, haz clic en el botón de restablecer.

Los gráficos individuales pueden desvincularse del tiempo global y establecerse en un marco de tiempo independiente.

Para ver un marco de tiempo diferente en un solo gráfico, edita el gráfico y usa el interruptor para desvincularlo del tiempo global. Cambia el marco de tiempo usando el selector de tiempo o desliza sobre el gráfico. Los cambios realizados en modo de edición se guardan automáticamente cuando haces clic en Listo. Para descartar sus cambios, haga clic en Cancelar en lugar de Listo.

Modos

Puede cambiar entre modos desde dentro del notebook seleccionando el menú desplegable en la parte superior derecha de tu notebook.

  • Editando: Haga cambios en el cuaderno.
  • Viendo: Los contenidos son Solo Lectura, lo que impide que los usuarios realicen ediciones no deseadas en configuraciones e información existentes.

Historial de versiones

Desde un notebook, haz clic en el ícono de engranaje y haz clic en Historial de versiones para abrir el panel lateral del Historial de Versiones. Puedes previsualizar, restaurar o clonar una versión anterior de tu notebook. Para más información, consulte la guía del Historial de Versiones.

Instantáneas de gráficos

Los Notebooks toman instantáneas automáticamente de los gráficos con rangos de tiempo fijos para preservar la visualización antes de que se apliquen los límites de retención de datos. No se requiere configuración. Utiliza el menú kebab junto a un gráfico para ver o descargar una instantánea.

Opción del menú kebab para ver o descargar una instantánea.

Las instantáneas son imágenes estáticas de gráficos con un rango de tiempo fijo (por ejemplo, Aug 18, 12:00 am - Aug 19, 11:59 pm). Una instantánea se actualiza cuando el gráfico se actualiza, siempre que el gráfico continúe utilizando un rango de tiempo fijo. Cambiar el gráfico a un rango de tiempo global (por ejemplo, Past 1 hour) elimina la instantánea.

Puedes previsualizar el estado de la instantánea de un Notebook al pasar el cursor sobre el indicador de instantánea del gráfico debajo del título del Notebook. La previsualización muestra la hora de la instantánea más reciente y el número de instantáneas creadas.

Indicador de instantánea que muestra cuántas instantáneas se han generado.

Cuando un Notebook contiene un gráfico con datos que han superado sus límites de retención de datos, el Notebook muestra una instantánea en línea del gráfico. La instantánea es una imagen estática, pero se reemplaza si editas el gráfico subyacente.

Permisos

Por defecto, todos los usuarios tienen acceso completo a los Notebooks.

Utiliza nuestros controles de acceso para restringir la visualización y edición solo a ti mismo:

  1. Mientras visualizas un Notebook, haz clic en el botón Compartir en la parte superior derecha.
  2. Selecciona Privado para mí.
  3. Haz clic en Guardar.

Utiliza controles de acceso granulares para limitar los roles que pueden editar un Notebook en particular:

  1. Mientras visualizas un Notebook, haz clic en el botón Compartir en la parte superior derecha.
  2. Selecciona Personalizado.
  3. Actualiza el acceso de la Organización a Visualizador para revocar el acceso de edición al resto de la organización.
  4. Utiliza el menú desplegable para seleccionar uno o más roles, equipos o usuarios que puedan editar el Notebook.
  5. Haz clic en Agregar.
  6. El cuadro de diálogo se actualiza para mostrar que el rol que seleccionaste tiene el permiso de Editor.
  7. Haz clic en Guardar.

Nota: Para mantener tu acceso de edición al notebook, el sistema requiere que incluyas al menos un rol del cual seas miembro antes de guardar.

Debes tener acceso de edición para restaurar el acceso general a un notebook restringido. Completa los siguientes pasos:

  1. Mientras visualizas un Notebook, haz clic en el botón Compartir en la parte superior derecha.
  2. Selecciona Mi Organización.
  3. Haz clic en Guardar.

Encontrando notebooks

La página Notebooks List es el lugar para encontrar todos tus notebooks.

El campo de búsqueda admite búsqueda de texto completo. Escribe tu consulta para mostrar los notebooks relevantes como resultados.

Filtrando

Puedes filtrar notebooks con los siguientes métodos:

Tipo de FiltroDescripción
AutorPara filtrar por autor, selecciona el menú desplegable de autores e ingresa nombres para filtrar.
EquipoPara filtrar por equipo, selecciona el menú desplegable de equipos e ingresa los nombres de los equipos para filtrar.
Tipo de notebookFiltra por investigación, postmortem, runbook, informe o documentación.
Fecha de modificaciónFiltra según cuán recientemente se editó un notebook utilizando el menú desplegable de fecha de modificación.

También hay filtros rápidos para acceder a tus notebooks y notebooks etiquetados con tus equipos.

Regresar a

Si no hay filtros habilitados, la sección Regresar a aparece, mostrando los notebooks más recientes que has visto o editado.

Ordenando notebooks

Puedes ordenar los notebooks seleccionando los encabezados ⭐, detalles o modificados para ordenarlos por esos valores.

Lectura adicional