Modifier un widget de zone de texte
Si vous souhaitez inclure un texte explicatif à côté des graphiques de votre tableau de bord ou afficher le logo d'une entreprise dans votre tableau de bord, vous pouvez modifier un widget de zone de texte. Le widget de zone de texte vous permet d'afficher du texte, des liens, des images ou des exemples de mesures dans votre tableau de bord.
Vidéo : | Consultez la formation associée : Fournir du contexte à l'aide de widgets de zone de texte |
Le widget de zone de texte prend en charge Markdown, une syntaxe de mise en forme simple qui convertit le texte brut en HTML avec des caractères non alphabétiques, tels que « # » ou « * ». Les nouveaux widgets de zone de texte contiennent des exemples Markdown. Un widget de zone de texte est automatiquement fourni chaque fois que vous créer un tableau de bord. Vous pouvez également ajouter un widget de zone de texte à la mise en page de votre tableau de bord.
Pour modifier un widget de zone de texte existant, procédez comme suit :
Formater le texte dans Markdown
Le tableau suivant présente les formats Markdown courants pris en charge dans le widget de zone de texte.
Remarque : | D'autres exemples de formats Markdown sont fournis dans le Guides GitHub : Maîtriser Markdown et dans le Spécification CommonMark . |
Formater | Descriptif | Exemple |
---|---|---|
Rubriques | Placez un signe numérique (#) et un espace devant votre texte pour mettre en forme les titres. Le niveau du titre est déterminé par le nombre de signes numériques. | #### Example H4 heading |
Listes non ordonnées | Placez un astérisque (*) avant votre texte. Si possible, placez chaque élément de la liste sur une ligne distincte. |
* First example
* Second example |
Listes ordonnées | Placez le chiffre 1 et le point (1.) avant votre texte pour chaque élément de ligne ; Markdown incrémentera automatiquement le numéro de liste. Si possible, placez chaque élément de la liste sur une ligne distincte. |
1. First example
1. Second example |
AUDACIEUX | Placez un double astérisque avant et après votre texte. | **bold text** |
Italiques | Placez un trait de soulignement avant et après votre texte. | _italicized text_ |
Hyperliens |
Placez le texte du lien entre crochets avant l'URL entre parenthèses. Ou saisissez votre URL. Les liens vers des sites Web externes s'ouvrent dans un nouvel onglet du navigateur. Les liens du système ExtraHop, tels que les tableaux de bord, s'ouvrent dans l'onglet actuel du navigateur. |
[Visit our home page](https://www.extrahop.com) https://www.extrahop.com |
Citations en blocs | Placez un crochet à angle droit et un espace devant votre texte. |
On the ExtraHop website: > Access the live demo and review case studies. |
Fonte Monospace | Placez un backtick (`) avant et après votre texte. | `example code block` |
Emojis | Copiez et collez une image emoji dans la zone de texte. Consultez les Graphique Emoji Unicode site web pour les images. La syntaxe Markdown ne prend pas en charge les shortcodes emoji. |
Ajouter des images dans Markdown
Vous pouvez ajouter des images au widget de zone de texte en créant un lien vers celles-ci. Assurez-vous que votre image est hébergée sur un réseau accessible au système ExtraHop.
Les liens vers les images doivent être spécifiés dans le format suivant :
![<alt_text>](<file_path>)
Où <alt_text> est le texte alternatif pour le nom de l'image et <file_path> est le chemin de l'image. Par exemple :
![Graph](/images/graph_1.jpg)
Remarque : | Vous pouvez également ajouter des images en les encodant en Base64. Pour plus d'informations, consultez le post suivant sur le forum ExtraHop, »Placer des images dans des zones de texte. » |
Ajouter des exemples métriques dans Markdown
Vous pouvez écrire une requête métrique pour inclure une valeur métrique en ligne avec le texte du widget de zone de texte. Par exemple, pour indiquer le nombre de serveurs Web ayant renvoyé une erreur 404, vous pouvez ajouter une requête métrique à une phrase et la valeur est mise à jour dans le texte.
L'exemple suivant montre le format de base pour écrire des requêtes métriques :
%%metric:{ "metric_category": "<metric_category>", "object_type": "<object_type>", "object_ids": [object_id], "metric_specs": [ { "name": "<metric_spec>" } ] }%%
Pour localiser le object_type, metric_spec, et metric_category pour les valeurs d'une métrique, procédez comme suit :
- Cliquez Réglages
- Cliquez Catalogue métrique.
- Entrez le nom de la métrique dans le champ de recherche.
- Sélectionnez la métrique et notez les valeurs de metric_category, object_type, et metric_spec dans le Paramètres de l'API REST section.
![](/images/9.7/metric_rest_api_parameters.png)
Pour localiser le object_id pour un équipement, un groupe de dispositifs ou un autre actif , procédez comme suit :
- Cliquez Actifs, puis cliquez sur un type d'actif dans le volet de gauche.
- Cliquez sur le nom de l'actif souhaité, puis ouvrez la fenêtre des propriétés.
- Notez la valeur affichée pour l'ID de l'API REST.
![](/images/9.7/device_rest_api_id.png)
Après avoir localisé les valeurs de la métrique que vous souhaitez afficher, ajoutez-les à la requête métrique dans l'éditeur de texte. La valeur sera affichée dans le widget de texte.
![](/images/9.7/text_widget_metric_value.png)
Remarque : | Les requêtes métriques suivantes ne sont pas prises en charge dans le widget de zone de texte :
|
Exemples de requêtes métriques pour le widget de zone de texte
Les exemples suivants vous montrent comment écrire des requêtes métriques de haut niveau, ou de base, pour des objets d' application, d'équipement et de réseau. Vous pouvez également rédiger une requête pour obtenir des métriques détaillées.
Métriques relatives aux applications
Pour spécifier l'objet All Activity, object_ids est »0».
Cet exemple de requête montre comment récupérer des métriques HTTP à partir de l'objet d' application All Activity et affiche le résultat suivant : »Getting [value] HTTP requests and [value] HTTP responses from All Activity.»
Getting %%metric:{ "object_type": "application", "object_ids": [0], "metric_category": "http", "metric_specs": [{"name":"req"}] }%%HTTP requests and %%metric:{ "object_type": "application", "object_ids": [0], "metric_category": "http", "metric_specs": [{"name":"rsp"}] }%% HTTP responses from All Activity.
Métriques de l'appareil
Vous devez spécifier soit un client (»_client») ou serveur (»_server») dans le metric_category. Pour récupérer les métriques d'un équipement spécifique, spécifiez le numéro d'identification de l'objet de l'équipement dans object_ids. Pour récupérer l'identifiant de l'objet de l'équipement (deviceOid), recherchez l'objet de l'équipement dans la recherche globale ExtraHop. Sélectionnez l'équipement dans les résultats de recherche. Le »deviceOid=» la valeur sera incorporée dans la chaîne de requête URL.
Cet exemple de requête montre comment récupérer des métriques à partir d'un objet client d'équipement et affiche le résultat suivant : »Getting [value] CLIENT DNS response errors from a specific device.»
Getting %%metric:{"object_type": "device", "object_ids": [8], "metric_category": "dns_client", "metric_specs": [{"name":"rsp_error"}] }%% CLIENT DNS response errors from a specific device.
Cet exemple de requête montre comment récupérer des métriques à partir d'un objet de serveur d'équipement et affiche le résultat suivant : »Getting [value] SERVER DNS response errors from a specific device.»
Getting %%metric:{ "object_type": "device", "object_ids": [156], "metric_category": "dns_server", "metric_specs": [{"name":"rsp_error"}] }%% SERVER DNS response errors from a specific device.
Métriques du réseau
Pour spécifier tous les réseaux, object_type est »capture» et le object_ids est »0. » Pour spécifier un VLAN spécifique, object_type est »vlan» et le object_ids est le numéro de VLAN.
Cet exemple de requête montre comment récupérer des métriques pour tous les réseaux et affiche le résultat suivant : »Getting [value] broadcast packets from all networks.»
Getting %%metric:{ "object_type": "capture", "object_ids": [0], "metric_category": "net","metric_specs": [{"name":"frame_cast_broadcast_pkts"}] }%% broadcast packets from all networks.
Cet exemple de requête montre comment récupérer des métriques pour un VLAN spécifique et affiche le résultat suivant : »Getting [value] broadcast packets from VLAN 3.»
Getting %%metric:{ "object_type": "vlan", "object_ids": [3], "metric_category": "net", "metric_specs": [{"name":"frame_cast_broadcast_pkts"}] }%% broadcast packets from VLAN 3.
Métriques du groupe
Pour spécifier un groupe, object_type est »device_group. » Vous devez spécifier soit un client (»_client») ou serveur (»_server») dans le metric_category. Le object_ids pour le groupe spécifique doit être récupéré depuis l' explorateur d'API REST.
Cet exemple de requête montre comment récupérer des métriques pour tous les réseaux et affiche le résultat suivant : »Getting [value] HTTP responses from the HTTP Client Device Group.»
Getting %%metric:{ "object_type": "device_group", "object_ids": [17], "metric_category": "http_client", "metric_specs": [{"name":"req"}] }%% HTTP responses from the HTTP Client Device Group.
Métriques détaillées
Si vous souhaitez récupérer des métriques détaillées, votre requête de métrique doit contenir des paramètres clés supplémentaires, tels que key1 et key2 :
- type_objet
- identifiant_objets
- catégorie_métrique
- metric_spec
- nom
- clé1
- clé 2
Important : | Vous devez fournir le object_ids dans votre requête. |
Cet exemple montre comment récupérer des requêtes HTTP par URI pour l'application All Activity (object_ids est »0») :
%%metric:{ "object_type": "application", "object_ids": [0], "metric_category": "http_uri_detail", "metric_specs": [{"name":"req"}] }%%
Cet exemple de requête vous montre comment récupérer des requêtes HTTP par des URI contenant une valeur clé pour »pagead2» pour l'application All Activity (object_ids est »0») :
%%metric:{ "metric_category": "http_uri_detail", "object_type": "application", "object_ids": [0], "metric_specs": [ { "name": "req", "key1": "/pagead2/" } ] }%%
Cet exemple de requête montre comment récupérer les mesures de comptage pour tous les réseaux et affiche le résultat suivant : »Getting [value] detail ICA metrics on all networks.»
Getting %%metric:{ "object_type": "capture", "object_ids": [0], "metric_category": "custom_detail", "metric_specs": [{ "name":"custom_count", "key1":"network-app-byte-detail-ICA" }] }%% detail ICA metrics on all networks.
Cet exemple de requête montre comment récupérer une statistique de jeu de données personnalisée avec des clés topn et des percentiles, et affiche le résultat suivant : »The fifth percentile is: [value].»
The fifth percentile is: %%metric:{ "object_type": "vlan", "object_ids": [1], "metric_category": "custom_detail", "metric_specs": [{ "name": "custom_dset", "key1": "myCustomDatasetDetail", "key2": "/10.10.7/", "calc_type": "percentiles", "percentiles": [5] }] }%% .
Remarque : | Exemples de métriques ne sont pas pris en charge dans le widget de zone de texte. Par exemple, en ajoutant le "calc_type": "mean" le paramètre de votre requête de zone de texte n'est pas pris en charge. |
Nous vous remercions pour vos commentaires. Pouvons-nous vous contacter pour vous poser des questions complémentaires ?