Bir Logtail işlem hattı yapılandırmasını günceller.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
log:UpdateLogtailPipelineConfig |
update |
*All resources.
|
|
None |
Request syntax
PUT /pipelineconfigs/{configName} HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| configName |
string |
Yes |
Logtail işlem hattı yapılandırmasının adı. |
test-config |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| project |
string |
Yes |
Projenin adı. |
test-project |
| body |
object |
No |
Logtail işlem hattı yapılandırmasının içeriği. |
|
| aggregators |
array<object> |
No |
Toplayıcı eklentilerinin listesi. Önemli Bu parametre yalnızca genişletilmiş işleme eklentileri kullanıldığında geçerli olur. En fazla bir toplayıcı eklentisine izin verilir. |
|
|
object |
No |
Toplayıcı eklentisi. |
||
| configName |
string |
Yes |
Yapılandırmanın adı. Önemli Bu ad, dış seviyedeki configName parametresinin değeriyle aynı olmalıdır. |
test-config |
| flushers |
array<object> |
Yes |
Çıktı eklentilerinin listesi. Önemli Şu anda yalnızca bir Simple Log Service çıktı eklentisine izin verilmektedir. |
|
|
object |
No |
Çıktı eklentisi. |
{ "Type": "flusher_sls", "Logstore": "test" } |
|
| global |
object |
No |
Genel yapılandırmalar. |
|
| inputs |
array<object> |
Yes |
Giriş eklentilerinin listesi. Önemli Şu anda yalnızca bir giriş eklentisi yapılandırılabilir. |
|
|
object |
No |
Giriş eklentisi. Not
Dosya giriş eklentisinin parametreleri için Dosya eklentisi bölümüne bakın. Diğer giriş eklentilerinin parametreleri için İşleme eklentileri bölümüne bakın. |
{ "Type": "input_file", "FilePaths": ["/var/log/*.log"] } |
|
| logSample |
string |
No |
Günlük örneği. Birden fazla günlük desteklenir. |
2022-06-14 11:13:29.796 | DEBUG | __main__: |
| processors |
array<object> |
No |
İşleme eklentilerinin listesi. Not
İşleme eklentileri, yerel işleme eklentileri ve genişletilmiş işleme eklentileri olarak ikiye ayrılır. Daha fazla bilgi için İşleme eklentileri bölümüne bakın. Önemli
Not
|
|
|
object |
No |
İşleme eklentisi. Not
Daha fazla bilgi için İşleme eklentileri bölümüne bakın. |
{ "Type": "processor_parse_json_native", "SourceKey": "content" } |
|
| task |
object |
No |
Görev yapılandırması. |
{'taskId': 'xxxxxxxxx'} |
Genel yapılandırmalar
| Parametre | Tür | Gerekli | Varsayılan değer | Örnek | Açıklama |
| TopicType | string | Hayır | Boş | filepath | Konu türü. Geçerli değerler:
|
| TopicFormat | string | Hayır. TopicType, filepath veya custom olarak ayarlandığında gereklidir. | / | /var/log/(.*).log | Konu biçimi. |
| EnableTimestampNanosecond | bool | Hayır | false | false | Zaman damgaları için nanosaniye hassasiyetinin etkinleştirilip etkinleştirilmeyeceğini belirtir. |
| PipelineMetaTagKey | object | Hayır | Boş | {"HOST_NAME":"__hostname__"} | Önemli Yalnızca LoongCollector 3.0.10 ve sonraki sürümler tarafından desteklenir.
|
Giriş eklentileri.
Dosya giriş eklentisi
| Parametre | Tür | Gerekli | Varsayılan değer | Örnek | Açıklama |
| Type | string | Evet | / | input_file | Eklenti türü. Değeri input_file olarak ayarlayın. |
| FilePaths | [string] | Evet | / | ["/var/log/*.log"] | Toplanacak günlük dosyası yollarının listesi. Şu anda yalnızca bir yol desteklenmektedir. Yolda * ve ** joker karakterlerini kullanabilirsiniz. ** joker karakteri yalnızca bir kez görünebilir ve dosya adından önce kullanılmalıdır. |
| MaxDirSearchDepth | uint | Hayır | 0 | 0 | Dosya yolundaki ** joker karakteri için maksimum dizin derinliği. Bu parametre yalnızca günlük yolunda ** joker karakteri kullanıldığında geçerlidir. Geçerli değerler: 0 ile 1000 arası. |
| ExcludeFilePaths | [string] | Hayır | Boş | ["/home/admin/*.log"] | Dosya yollarının kara listesi. Yollar mutlak yollar olmalıdır. * joker karakteri desteklenir. |
| ExcludeFiles | [string] | Hayır | Boş | ["app*.log", "password"] | Dosya adlarının kara listesi. * joker karakteri desteklenir. |
| ExcludeDirs | [string] | Hayır | Boş | ["/home/admin/dir1", "/home/admin/dir2*"] | Dizinlerin kara listesi. Yollar mutlak yollar olmalıdır. * joker karakteri desteklenir. |
| FileEncoding | string | Hayır | utf8 | utf8 | Dosyanın kodlama biçimi. Geçerli değerler: utf8 ve gbk. |
| TailSizeKB | uint | Hayır | 1024 | 1024 | Yapılandırma ilk kez etkili olduğunda, eşleşen dosyanın sonundan başlangıç toplama konumuna kadar olan boyut. Dosya boyutu bu değerden küçükse, toplama dosyanın başından başlar. Geçerli değerler: 0 ile 10485760 arası. Birim: KB. |
| Multiline | object | Hayır | Boş | / | Çok satırlı birleştirme seçenekleri. |
| Multiline.Mode | string | Hayır | custom | custom | Çok satırlı birleştirme modu. Geçerli değerler: custom ve JSON. |
| Multiline.StartPattern | string | Multiline.Mode, custom olarak ayarlandığında gereklidir. | Boş | \d+-\d+-\d+.* | Bir günlüğün ilk satırı için normal ifade. |
| EnableContainerDiscovery | bool | Hayır | false | true | Konteyner keşfi özelliğinin etkinleştirilip etkinleştirilmeyeceğini belirtir. Bu parametre yalnızca Logtail DaemonSet modunda çalıştığında ve toplama dosyası yolu konteyner içindeki bir yol olduğunda geçerlidir. |
| ContainerFilters | object | Hayır | Boş | / | Konteyner filtreleme seçenekleri. Birden fazla seçenek AND operatörü ile bağlanır. Bu parametre yalnızca EnableContainerDiscovery true olarak ayarlandığında geçerlidir. |
| ContainerFilters.K8sNamespaceRegex | string | Hayır | Boş | default | Bir Kubernetes kümesinde dağıtılan konteynerler için, toplanacak konteynerin bulunduğu podun ad alanı koşulu. Bu parametre eklenmezse tüm konteynerler toplanır. Normal ifade eşleştirmesi desteklenir. |
| ContainerFilters.K8sPodRegex | string | Hayır | Boş | test-pod | Bir Kubernetes kümesinde dağıtılan konteynerler için, toplanacak konteynerin bulunduğu podun adı koşulu. Bu parametre eklenmezse tüm konteynerler toplanır. Normal ifade eşleştirmesi desteklenir. |
| ContainerFilters.IncludeK8sLabel | map | Hayır | Boş | / | Bir Kubernetes kümesinde dağıtılan konteynerler için, toplanacak konteynerin bulunduğu podun etiket koşulu. Birden fazla koşul OR operatörü ile bağlanır. Bu parametre eklenmezse tüm konteynerler toplanır. Normal ifade eşleştirmesi desteklenir. Haritadaki anahtar pod etiket adıdır ve değer pod etiket değeridir. Açıklama:
|
| ContainerFilters.ExcludeK8sLabel | map | Hayır | Boş | / | Bir Kubernetes kümesinde dağıtılan konteynerler için, hariç tutulacak konteynerin bulunduğu podun etiket koşulu. Birden fazla koşul OR operatörü ile bağlanır. Bu parametre eklenmezse tüm konteynerler toplanır. Normal ifade eşleştirmesi desteklenir. Haritadaki anahtar pod etiket adıdır ve değer pod etiket değeridir. Açıklama:
|
| ContainerFilters.K8sContainerRegex | string | Hayır | Boş | test-container | Bir Kubernetes kümesinde dağıtılan konteynerler için, toplanacak konteynerin adı koşulu. Bu parametre eklenmezse tüm konteynerler toplanır. Normal ifade eşleştirmesi desteklenir. |
| ContainerFilters.IncludeEnv | map | Hayır | Boş | / | Toplanacak konteynerin ortam değişkeni koşulu. Birden fazla koşul OR operatörü ile bağlanır. Bu parametre eklenmezse tüm konteynerler toplanır. Normal ifade eşleştirmesi desteklenir. Haritadaki anahtar ortam değişkeni adıdır ve değer ortam değişkeni değeridir. Açıklama:
|
| ContainerFilters.ExcludeEnv | map | Hayır | Boş | / | Hariç tutulacak konteynerin ortam değişkeni koşulu. Birden fazla koşul OR operatörü ile bağlanır. Bu parametre eklenmezse tüm konteynerler toplanır. Normal ifade eşleştirmesi desteklenir. Haritadaki anahtar ortam değişkeni adıdır ve değer ortam değişkeni değeridir. Açıklama:
|
| ContainerFilters.IncludeContainerLabel | map | Hayır | Boş | / | Toplanacak konteynerin etiket koşulu. Birden fazla koşul OR operatörü ile bağlanır. Bu parametre eklenmezse varsayılan değer boştur, bu da tüm konteynerlerin toplandığı anlamına gelir. Normal ifade eşleştirmesi desteklenir. Haritadaki anahtar konteyner etiket adıdır ve değer konteyner etiket değeridir. Açıklama:
|
| ContainerFilters.ExcludeContainerLabel | map | Hayır | Boş | / | Hariç tutulacak konteynerin etiket koşulu. Birden fazla koşul OR operatörü ile bağlanır. Bu parametre eklenmezse varsayılan değer boştur, bu da tüm konteynerlerin toplandığı anlamına gelir. Normal ifade eşleştirmesi desteklenir. Haritadaki anahtar konteyner etiket adıdır ve değer konteyner etiket değeridir. Açıklama:
|
| ExternalK8sLabelTag | map | Hayır | Boş | / | Bir Kubernetes kümesinde dağıtılan konteynerler için, günlüğe eklenmesi gereken pod etiketleriyle ilgili etiketler. Haritadaki anahtar pod etiket adıdır ve değer karşılık gelen etiket adıdır. Örneğin, haritaya app: k8s\_label\_app eklerseniz ve pod app=serviceA etiketini içeriyorsa, bu bilgi günlüğe bir etiket olarak eklenir, yani __tag__:k8s_label_app: serviceA alanı eklenir. Pod app etiketini içermiyorsa, boş bir __tag__:k8s_label_app: alanı eklenir. |
| ExternalEnvTag | map | Hayır | Boş | / | Bir Kubernetes kümesinde dağıtılan konteynerler için, günlüğe eklenmesi gereken konteyner ortam değişkenleriyle ilgili etiketler. Haritadaki anahtar ortam değişkeni adıdır ve değer karşılık gelen etiket adıdır. Örneğin, haritaya VERSION: env\_version eklerseniz ve konteyner VERSION=v1.0.0 ortam değişkenini içeriyorsa, bu bilgi günlüğe bir etiket olarak eklenir, yani __tag__:env_version: v1.0.0 alanı eklenir. Konteyner VERSION ortam değişkenini içermiyorsa, boş bir __tag__:env_version: alanı eklenir. |
| CollectingContainersMeta | bool | Hayır | false | true | Konteyner meta verilerinin önizlemesinin etkinleştirilip etkinleştirilmeyeceğini belirtir. |
| AppendingLogPositionMeta | bool | Hayır | false | false | Günlüğün ait olduğu dosyanın meta verilerinin eklenip eklenmeyeceğini belirtir; __tag__:__inode__ alanı ve __file_offset__ alanı buna dahildir. |
| AllowingIncludedByMultiConfigs | bool | Hayır | false | false | Geçerli yapılandırmanın, diğer yapılandırmalar tarafından eşleştirilmiş dosyaları toplamasına izin verilip verilmeyeceğini belirtir. |
| Tags | object | Hayır | Boş | {"FileInodeTagKey":"__inode__"} | Önemli Yalnızca LoongCollector 3.0.10 ve sonraki sürümler tarafından desteklenir.
|
| FileOffsetKey | string | Hayır | Boş | __file_offset__ | Önemli Yalnızca LoongCollector 3.0.10 ve sonraki sürümler tarafından desteklenir. |
Konteyner standart çıktısı (eski)
| Parametre | Tür | Gerekli | Varsayılan değer | Örnek | Açıklama |
| Type | string | Evet | / | service_docker_stdout | Eklenti türü. Değeri service_docker_stdout olarak ayarlayın. |
| Stdout | Boolean | Hayır | true | true | Standart çıktının (stdout) toplanıp toplanmayacağını belirtir. |
| Stderr | Boolean | Hayır | true | true | Standart hatanın (stderr) toplanıp toplanmayacağını belirtir. |
| StartLogMaxOffset | Integer | Hayır | 128×1024 | 131072 | İlk toplama sırasında geriye dönük olarak izlenecek geçmiş verilerin uzunluğu. Birim: bayt. Değeri [131072, 1048576] aralığında bir sayı olarak ayarlamanızı öneririz. |
| IncludeLabel | LabelKey ve LabelValue değerlerinin String türünde olduğu Map | Hayır | Boş | Konteyner etiketlerinin beyaz listesi, toplanacak konteynerleri belirtmek için kullanılır. Varsayılan değer boştur, bu da tüm konteynerlerin standart çıktısının toplandığı anlamına gelir. Konteyner etiketleri için bir beyaz liste belirlemek istiyorsanız, LabelKey gereklidir ve LabelValue isteğe bağlıdır.
Birden fazla beyaz liste VEYA (OR) işleci ile bağlanır, bu da bir konteynerin etiketleri beyaz listelerden herhangi birini karşıladığı sürece eşleştirileceği anlamına gelir. | |
| ExcludeLabel | LabelKey ve LabelValue değerlerinin String türünde olduğu Map | Hayır | Boş | Konteyner etiketlerinin kara listesi, toplanması gerekmeyen konteynerleri hariç tutmak için kullanılır. Varsayılan değer boştur, bu da hiçbir konteynerin hariç tutulmadığı anlamına gelir. Konteyner etiketleri için bir kara liste belirlemek istiyorsanız, LabelKey gereklidir ve LabelValue isteğe bağlıdır.
Birden fazla kara liste VEYA (OR) işleci ile bağlanır, bu da bir konteynerin etiketleri kara listelerden herhangi birini karşıladığı sürece hariç tutulacağı anlamına gelir. | |
| IncludeEnv | EnvKey ve EnvValue değerlerinin String türünde olduğu Map | Hayır | Boş | Ortam değişkenlerinin beyaz listesi, toplanacak konteynerleri belirtmek için kullanılır. Varsayılan değer boştur, bu da tüm konteynerlerin standart çıktısının toplandığı anlamına gelir. Ortam değişkenleri için bir beyaz liste belirlemek istiyorsanız, EnvKey gereklidir ve EnvValue isteğe bağlıdır.
| |
| ExcludeEnv | EnvKey ve EnvValue değerlerinin String türünde olduğu Map | Hayır | Boş | Ortam değişkenlerinin kara listesi, toplanması gerekmeyen konteynerleri hariç tutmak için kullanılır. Varsayılan değer boştur, bu da hiçbir konteynerin hariç tutulmadığı anlamına gelir. Ortam değişkenleri için bir kara liste belirlemek istiyorsanız, EnvKey gereklidir ve EnvValue isteğe bağlıdır.
Birden fazla kara liste VEYA (OR) işleci ile bağlanır, bu da bir konteynerin ortam değişkenleri anahtar-değer çiftlerinden herhangi birini karşıladığı sürece hariç tutulacağı anlamına gelir. | |
| IncludeK8sLabel | LabelKey ve LabelValue değerlerinin String türünde olduğu Map | Hayır | Boş | Kubernetes etiketlerinin (template.metadata içinde tanımlanır) beyaz listesi, toplanacak konteynerleri belirtmek için kullanılır. Kubernetes etiketleri için bir beyaz liste belirlemek istiyorsanız, LabelKey gereklidir ve LabelValue isteğe bağlıdır.
Birden fazla beyaz liste VEYA (OR) işleci ile bağlanır, bu da bir konteynerin Kubernetes etiketleri beyaz listelerden herhangi birini karşıladığı sürece eşleştirileceği anlamına gelir. | |
| ExcludeK8sLabel | LabelKey ve LabelValue değerlerinin String türünde olduğu Map | Hayır | Boş | Kubernetes etiketlerinin (template.metadata içinde tanımlanır) kara listesi, toplanması gerekmeyen konteynerleri hariç tutmak için kullanılır. Kubernetes etiketleri için bir kara liste belirlemek istiyorsanız, LabelKey gereklidir ve LabelValue isteğe bağlıdır.
Birden fazla kara liste VEYA (OR) işleci ile bağlanır, bu da bir konteynerin Kubernetes etiketleri kara listelerden herhangi birini karşıladığı sürece hariç tutulacağı anlamına gelir. | |
| K8sNamespaceRegex | String | Hayır | Boş | ^(default|nginx)$ | Ad alanı adına göre toplanacak konteynerleri belirtir. Normal ifade eşleştirmesi desteklenir. Örneğin, değeri ^(default|nginx)$ olarak ayarlarsanız, nginx ve default ad alanlarındaki tüm konteynerler eşleştirilir. |
| K8sPodRegex | String | Hayır | Boş | ^(nginx-log-demo.*)$ | Pod adına göre toplanacak konteynerleri belirtir. Normal ifade eşleştirmesi desteklenir. Örneğin, değeri ^(nginx-log-demo.*)$ olarak ayarlarsanız, adları nginx-log-demo ile başlayan podlardaki tüm konteynerler eşleştirilir. |
| K8sContainerRegex | String | Hayır | Boş | ^(container-test)$ | Konteyner adına göre toplanacak konteynerleri belirtir (Kubernetes konteyner adı spec.containers içinde tanımlanır). Normal ifade eşleştirmesi desteklenir. Örneğin, değeri ^(container-test)$ olarak ayarlarsanız, container-test adlı tüm konteynerler eşleştirilir. |
Response elements
|
Element |
Type |
Description |
Example |
None defined.
Examples
Success response
JSON format
{}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.