{{ define "title" }} {{ .Title }} | Vector documentation {{ end }} {{ define "main" }} {{ $tag := .File.BaseFileName }} {{ $kind := .CurrentSection.Params.component_type }} {{ $config := index (index site.Data.docs.components $kind) $tag }} {{ $exampleConfigs := $config.example_configs }} {{ $noindex := .Params.noindex }}
{{ partial "breadcrumb.html" . }}

{{ .Title | markdownify }}

{{ with .Description }}

{{ . | markdownify }}

{{ end }}
{{ partial "docs/component-under-hero.html" . }}
{{ partial "page-actions.html" . }}
{{ with $config.description }}
{{ . | markdownify }}
{{ end }} {{ if $config.alias }} {{ partial "docs/component-alias.html" (dict "kind" $kind "alias" $config.alias "current" $tag) }} {{ end }} {{/* Component requirements */}} {{ with $config.support.requirements }} {{ partial "heading.html" (dict "text" "Requirements" "level" 2) }} {{ partial "data.html" (dict "component_requirements" .) }} {{ end }} {{/* Component warnings */}} {{ with $config.support.warnings }} {{ partial "heading.html" (dict "text" "Warnings" "level" 2) }} {{ partial "data.html" (dict "component_warnings" .) }} {{ end }} {{/* Component configuration */}} {{ with $config.configuration }} {{ if gt (len .) 1 }} {{/* Don't display if only the "type" config is present */}} {{ partial "heading.html" (dict "text" "Configuration" "level" 2) }} {{ partial "components/example-configs.html" (dict "examples" $exampleConfigs) }} {{ partial "data.html" (dict "component_config" . ) }} {{ end }} {{ end }} {{/* Component environment variables */}} {{ with $config.env_vars }} {{ partial "heading.html" (dict "text" "Environment variables" "level" 2) }} {{ partial "data.html" (dict "component_env_vars" . ) }} {{ end }} {{/* Component outputs */}} {{ with $config.outputs }} {{ partial "heading.html" (dict "text" "Outputs" "level" 2) }} {{ partial "data.html" (dict "component_outputs" . ) }} {{ end }} {{/* Component log/metric output */}} {{ with $config.output }} {{ partial "heading.html" (dict "text" "Output Data" "level" 2) }} {{ partial "data.html" (dict "component_output" . ) }} {{ end }} {{/* Component telemetry output */}} {{ with $config.telemetry }} {{ partial "heading.html" (dict "text" "Telemetry" "level" 2) }} {{ partial "data.html" (dict "component_telemetry" . ) }} {{ end }} {{/* Component examples */}} {{ with $config.examples }} {{ partial "heading.html" (dict "text" "Examples" "level" 2) }} {{ partial "data.html" (dict "component_examples" . ) }} {{ end }} {{/* Cloud platform permissions */}} {{ with $config.permissions }} {{ partial "heading.html" (dict "text" "Permissions" "level" 2) }} {{ partial "data.html" (dict "component_permissions" .) }} {{ end }} {{/* How it works */}} {{ with $config.how_it_works }}
{{ partial "heading.html" (dict "text" "How it works" "level" 2) }}
{{ range $k, $v := . }}
{{ partial "heading.html" (dict "text" $v.title "level" 3) }} {{ with .svg }} {{ partial "svg.html" (dict "src" .) }} {{ end }}
{{ $v.body | markdownify }}
{{ with $v.sub_sections }}
{{ range . }} {{ partial "heading.html" (dict "text" .title "level" 4) }} {{ with .svg }} {{ partial "svg.html" (dict "src" .) }} {{ end }}
{{ .body | markdownify }}
{{ end }}
{{ end }}
{{ end }}
{{ end }}
{{ end }} {{ define "below" }} {{ partial "docs/pagination.html" . }} {{ end }} {{ define "subfooter" }} {{ partial "docs/mobile-nav.html" . }} {{ end }}