Tento kurz vás provede vstupy a výstupy šablon indexu Elasticsearch, které vám umožní definovat šablony nebo plány pro běžné indexy. Například pokud neustále protokolováte data z externích zdrojů, můžete definovat podrobný plán pro všechny indexy protokolování.
POZNÁMKA: Než začneme, je dobré si uvědomit, že výukový program se zaměřuje na nejnovější verzi Elasticsearch-7.8 v době psaní - a může se lišit od ostatních verzí. Předpokládáme také, že máte někde spuštěný Elasticsearch v systému.
Začněme pracovat s šablonami indexu Elasticsearch.
Co je šablona indexu Elasticsearch?
Šablona indexu Elasticsearch je metoda používaná k instrukci Elasticsearch ke konfiguraci indexů při vytváření. Například šablona indexu použitá v datovém proudu konfiguruje záložní indexy streamu po vytvoření. Šablona indexu je vytvořena ručně před vytvořením indexu. Při vytváření indexu použije šablona nastavení konfigurace pro index.
Nejnovější verze Elasticsearch má dva typy použitelných šablon. Jedním z nich je indexová šablona, a druhá je šablony komponent. Jak jsme již vytvořili, šablony indexů pomáhají vytvářet indexy Elasticsearch.
Šablony komponent jsou opakovaně použitelné moduly nebo bloky používané ke konfiguraci nastavení, mapování a aliasů. Šablony komponent se neaplikují přímo na vytvořené indexy, ale mohou pomoci vytvořit šablony indexů.
Některé výchozí šablony indexů používané Elasticsearch zahrnují: metriky - * - *, protokoly - * - * .
Jak vytvořit šablonu rejstříku
K vytvoření nových indexových šablon nebo aktualizaci stávajících používáme PUT template API. Pomocí koncového bodu _index_template můžeme odeslat požadavek HTTP na přidání šablony.
Obecná syntaxe pro vytvoření šablony je:
PUT _index_template / template_nameJe dobré si uvědomit, že název šablony je povinný parametr. Zvažte níže uvedený požadavek, který vytvoří šablonu indexu jako template_1
PUT _index_template / template_1/ * Definujte vzor indexu * /
"index_patterns": ["te *"],
"priorita": 1,
/ * Definujte nastavení pro indexy * /
"template":
"settings":
"number_of_shards": 2
Pro uživatele cURL je příkaz:
curl -XPUT "http: // localhost: 9200 / _index_template / template_1" -H 'Content-Type: application / json' -d '/ * Definujte vzor indexu * / "index_patterns": ["te *"], "priority": 1, / * Definovat nastavení pro indexy * / "template": "settings": "number_of_shards": 2 'Elasticsearch používá vzor zástupných znaků k porovnání názvů indexů, kde jsou šablony použity. Změna nebo aktualizace šablony indexu neovlivní již vytvořené indexy, pouze ty, které budou vytvořeny po použití této šablony.
Z výše uvedeného můžete své šablony komentovat pomocí metody komentování v jazyce C. Můžete přidat libovolný počet komentářů, kamkoli v těle kromě otevření složených závorek.
V těle šablony indexu můžete zahrnout různé definice, například:
- Šablona: Vlastnost šablony (objekt) definuje, kterou šablonu použít; může obsahovat aliasy, mapování a nastavení - to je volitelný parametr.
- Složen z: Tato vlastnost definuje seznam názvů pro šablony komponent. Jakmile jsou šablony komponent definovány, budou sloučeny v pořadí jejich specifikace. To znamená, že poslední definovaná šablona komponenty má nejvyšší prioritu.
- Přednost: Vlastnost priority definuje přednost šablony indexu při vytváření indexu. Pokud má kterákoli priorita nejvyšší hodnotu, získá vyšší prioritu ve srovnání s nižšími hodnotami. Hodnota priority není požadována a je typu integer. 0 je výchozí hodnota pro nespecifikované šablony.
- Verze: Parametr verze určuje verzi šablony indexu, která pomáhá spravovat šablony.
V těle šablony indexu můžete zahrnout další vlastnosti. Další informace najdete v dokumentaci.
https: // www.elastický.co / guide / en / elasticsearch / reference / 7.10 / indexové šablony.html
Níže je uveden příklad požadavku na vytvoření nové šablony s verzí 1.0
PUT / _index_template / template_2"index_patterns": ["remp *", "re *"],
"priorita": 1,
"template":
"settings":
"number_of_shards": 2,
"number_of_replicas": 0
,
"verze": 1.0
Nemůžete mít více než jednu šablonu indexu se shodným vzorem a stejnou prioritou. Proto zajistěte přiřazení různých priorit tak, aby odpovídaly šablonám vzorů.
Jak získat šablonu rejstříku
Chcete-li zobrazit informace o šabloně indexu, odešlete požadavek GET do API _index_template. Chcete-li například zobrazit informace o template_2, použijte požadavek:
ZÍSKAT _index_template / template_2Příkaz cURL je:
curl -XGET "http: // localhost: 9200 / _index_template / template_2"Tento příkaz by měl zobrazit informace o template_2
"index_templates": [
"name": "template_2",
"index_template":
"index_patterns": [
"remp *",
"re*"
],
"template":
"settings":
"index":
"number_of_shards": "2",
"number_of_replicas": "0"
,
"složen z" : [ ],
"priorita": 1,
"verze": 1
]
Zástupné znaky můžete také použít k získání odpovídajících šablon. Zvažte například níže uvedený požadavek na zobrazení všech šablon v Elasticsearch.
ZÍSKAT _index_template / *Příkaz cURL je.
curl -XGET http: // localhost: 9200 / _index_template / *Tento příkaz by vám měl poskytnout informace o všech šablonách v Elasticsearch
"index_templates": [
"name": "ilm-history",
"index_template":
"index_patterns": [
"ilm-history-3 *"
],
"template":
"settings":
"index":
"format": "1",
"životní cyklus" :
"name": "ilm-history-ilm-policy",
"rollover_alias": "ilm-history-3"
,
"hidden": "true",
"number_of_shards": "1",
"auto_expand_replicas": "0-1",
"number_of_replicas": "0"
,
"mapování":
"dynamic": false,
"vlastnosti":
"index_age":
"type": "long"
,
"@timestamp":
"format": "epoch_millis",
"type": "date"
,
"detaily chyby" :
"type": "text"
,
"success":
"type": "boolean"
,
"index":
"type": "klíčové slovo"
,
"Stát" :
"dynamic": true,
"type": "objekt",
--------------------------VÝSTUP ZKRACOVÁN-----------------------------------
Jak odstranit šablony
Odstranění šablony je stejně jednoduché jako šablona GET, ale pomocí požadavku DELETE jako:
ODSTRANIT _index_template / template_2Můžete použít příkaz cURL:
curl -XDELETE "http: // localhost: 9200 / _index_template / template_2"Tento příkaz automaticky odstraní zadanou šablonu.
Závěr
Tento kurz se zabýval tím, co jsou šablony indexu Elasticsearch, jak fungují a jak vytvářet, zobrazovat a mazat šablony indexů. Tyto základní informace by vám měly pomoci začít používat šablony indexu Elasticsearch.