Skip to content

Commit cdde69b

Browse files
vparfonovvparfonov
committed
Generate component docs
1 parent 335dca4 commit cdde69b

29 files changed

+1458
-1
lines changed

‎website/cue/reference/components/sinks/generated/amqp.cue‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,10 @@ generated: components: sinks: amqp: configuration: {
227227
transform) and removing the message field while doing additional parsing on it, as this
228228
could lead to the encoding emitting empty strings for the given event.
229229
"""
230+
syslog: """
231+
Syslog encoding
232+
RFC 3164 and 5424 are supported
233+
"""
230234
text: """
231235
Plain text encoding.
232236
@@ -412,6 +416,54 @@ generated: components: sinks: amqp: configuration: {
412416
}
413417
}
414418
}
419+
syslog: {
420+
description: "Options for the Syslog serializer."
421+
relevant_when: "codec = \"syslog\""
422+
required: false
423+
type: object: options: {
424+
app_name: {
425+
description: """
426+
Path to a field in the event to use for the app name.
427+
428+
If not provided, the encoder checks for a semantic "service" field.
429+
If that is also missing, it defaults to "vector".
430+
"""
431+
required: false
432+
type: string: {}
433+
}
434+
facility: {
435+
description: "Path to a field in the event to use for the facility. Defaults to \"user\"."
436+
required: false
437+
type: string: {}
438+
}
439+
msg_id: {
440+
description: "Path to a field in the event to use for the msg ID."
441+
required: false
442+
type: string: {}
443+
}
444+
proc_id: {
445+
description: "Path to a field in the event to use for the proc ID."
446+
required: false
447+
type: string: {}
448+
}
449+
rfc: {
450+
description: "RFC to use for formatting."
451+
required: false
452+
type: string: {
453+
default: "rfc5424"
454+
enum: {
455+
rfc3164: "The legacy RFC3164 syslog format."
456+
rfc5424: "The modern RFC5424 syslog format."
457+
}
458+
}
459+
}
460+
severity: {
461+
description: "Path to a field in the event to use for the severity. Defaults to \"informational\"."
462+
required: false
463+
type: string: {}
464+
}
465+
}
466+
}
415467
timestamp_format: {
416468
description: "Format used for timestamp fields."
417469
required: false

‎website/cue/reference/components/sinks/generated/aws_cloudwatch_logs.cue‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -423,6 +423,10 @@ generated: components: sinks: aws_cloudwatch_logs: configuration: {
423423
transform) and removing the message field while doing additional parsing on it, as this
424424
could lead to the encoding emitting empty strings for the given event.
425425
"""
426+
syslog: """
427+
Syslog encoding
428+
RFC 3164 and 5424 are supported
429+
"""
426430
text: """
427431
Plain text encoding.
428432
@@ -608,6 +612,54 @@ generated: components: sinks: aws_cloudwatch_logs: configuration: {
608612
}
609613
}
610614
}
615+
syslog: {
616+
description: "Options for the Syslog serializer."
617+
relevant_when: "codec = \"syslog\""
618+
required: false
619+
type: object: options: {
620+
app_name: {
621+
description: """
622+
Path to a field in the event to use for the app name.
623+
624+
If not provided, the encoder checks for a semantic "service" field.
625+
If that is also missing, it defaults to "vector".
626+
"""
627+
required: false
628+
type: string: {}
629+
}
630+
facility: {
631+
description: "Path to a field in the event to use for the facility. Defaults to \"user\"."
632+
required: false
633+
type: string: {}
634+
}
635+
msg_id: {
636+
description: "Path to a field in the event to use for the msg ID."
637+
required: false
638+
type: string: {}
639+
}
640+
proc_id: {
641+
description: "Path to a field in the event to use for the proc ID."
642+
required: false
643+
type: string: {}
644+
}
645+
rfc: {
646+
description: "RFC to use for formatting."
647+
required: false
648+
type: string: {
649+
default: "rfc5424"
650+
enum: {
651+
rfc3164: "The legacy RFC3164 syslog format."
652+
rfc5424: "The modern RFC5424 syslog format."
653+
}
654+
}
655+
}
656+
severity: {
657+
description: "Path to a field in the event to use for the severity. Defaults to \"informational\"."
658+
required: false
659+
type: string: {}
660+
}
661+
}
662+
}
611663
timestamp_format: {
612664
description: "Format used for timestamp fields."
613665
required: false

‎website/cue/reference/components/sinks/generated/aws_kinesis_firehose.cue‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -402,6 +402,10 @@ generated: components: sinks: aws_kinesis_firehose: configuration: {
402402
transform) and removing the message field while doing additional parsing on it, as this
403403
could lead to the encoding emitting empty strings for the given event.
404404
"""
405+
syslog: """
406+
Syslog encoding
407+
RFC 3164 and 5424 are supported
408+
"""
405409
text: """
406410
Plain text encoding.
407411
@@ -587,6 +591,54 @@ generated: components: sinks: aws_kinesis_firehose: configuration: {
587591
}
588592
}
589593
}
594+
syslog: {
595+
description: "Options for the Syslog serializer."
596+
relevant_when: "codec = \"syslog\""
597+
required: false
598+
type: object: options: {
599+
app_name: {
600+
description: """
601+
Path to a field in the event to use for the app name.
602+
603+
If not provided, the encoder checks for a semantic "service" field.
604+
If that is also missing, it defaults to "vector".
605+
"""
606+
required: false
607+
type: string: {}
608+
}
609+
facility: {
610+
description: "Path to a field in the event to use for the facility. Defaults to \"user\"."
611+
required: false
612+
type: string: {}
613+
}
614+
msg_id: {
615+
description: "Path to a field in the event to use for the msg ID."
616+
required: false
617+
type: string: {}
618+
}
619+
proc_id: {
620+
description: "Path to a field in the event to use for the proc ID."
621+
required: false
622+
type: string: {}
623+
}
624+
rfc: {
625+
description: "RFC to use for formatting."
626+
required: false
627+
type: string: {
628+
default: "rfc5424"
629+
enum: {
630+
rfc3164: "The legacy RFC3164 syslog format."
631+
rfc5424: "The modern RFC5424 syslog format."
632+
}
633+
}
634+
}
635+
severity: {
636+
description: "Path to a field in the event to use for the severity. Defaults to \"informational\"."
637+
required: false
638+
type: string: {}
639+
}
640+
}
641+
}
590642
timestamp_format: {
591643
description: "Format used for timestamp fields."
592644
required: false

‎website/cue/reference/components/sinks/generated/aws_kinesis_streams.cue‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -402,6 +402,10 @@ generated: components: sinks: aws_kinesis_streams: configuration: {
402402
transform) and removing the message field while doing additional parsing on it, as this
403403
could lead to the encoding emitting empty strings for the given event.
404404
"""
405+
syslog: """
406+
Syslog encoding
407+
RFC 3164 and 5424 are supported
408+
"""
405409
text: """
406410
Plain text encoding.
407411
@@ -587,6 +591,54 @@ generated: components: sinks: aws_kinesis_streams: configuration: {
587591
}
588592
}
589593
}
594+
syslog: {
595+
description: "Options for the Syslog serializer."
596+
relevant_when: "codec = \"syslog\""
597+
required: false
598+
type: object: options: {
599+
app_name: {
600+
description: """
601+
Path to a field in the event to use for the app name.
602+
603+
If not provided, the encoder checks for a semantic "service" field.
604+
If that is also missing, it defaults to "vector".
605+
"""
606+
required: false
607+
type: string: {}
608+
}
609+
facility: {
610+
description: "Path to a field in the event to use for the facility. Defaults to \"user\"."
611+
required: false
612+
type: string: {}
613+
}
614+
msg_id: {
615+
description: "Path to a field in the event to use for the msg ID."
616+
required: false
617+
type: string: {}
618+
}
619+
proc_id: {
620+
description: "Path to a field in the event to use for the proc ID."
621+
required: false
622+
type: string: {}
623+
}
624+
rfc: {
625+
description: "RFC to use for formatting."
626+
required: false
627+
type: string: {
628+
default: "rfc5424"
629+
enum: {
630+
rfc3164: "The legacy RFC3164 syslog format."
631+
rfc5424: "The modern RFC5424 syslog format."
632+
}
633+
}
634+
}
635+
severity: {
636+
description: "Path to a field in the event to use for the severity. Defaults to \"informational\"."
637+
required: false
638+
type: string: {}
639+
}
640+
}
641+
}
590642
timestamp_format: {
591643
description: "Format used for timestamp fields."
592644
required: false

‎website/cue/reference/components/sinks/generated/aws_s3.cue‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -511,6 +511,10 @@ generated: components: sinks: aws_s3: configuration: {
511511
transform) and removing the message field while doing additional parsing on it, as this
512512
could lead to the encoding emitting empty strings for the given event.
513513
"""
514+
syslog: """
515+
Syslog encoding
516+
RFC 3164 and 5424 are supported
517+
"""
514518
text: """
515519
Plain text encoding.
516520
@@ -696,6 +700,54 @@ generated: components: sinks: aws_s3: configuration: {
696700
}
697701
}
698702
}
703+
syslog: {
704+
description: "Options for the Syslog serializer."
705+
relevant_when: "codec = \"syslog\""
706+
required: false
707+
type: object: options: {
708+
app_name: {
709+
description: """
710+
Path to a field in the event to use for the app name.
711+
712+
If not provided, the encoder checks for a semantic "service" field.
713+
If that is also missing, it defaults to "vector".
714+
"""
715+
required: false
716+
type: string: {}
717+
}
718+
facility: {
719+
description: "Path to a field in the event to use for the facility. Defaults to \"user\"."
720+
required: false
721+
type: string: {}
722+
}
723+
msg_id: {
724+
description: "Path to a field in the event to use for the msg ID."
725+
required: false
726+
type: string: {}
727+
}
728+
proc_id: {
729+
description: "Path to a field in the event to use for the proc ID."
730+
required: false
731+
type: string: {}
732+
}
733+
rfc: {
734+
description: "RFC to use for formatting."
735+
required: false
736+
type: string: {
737+
default: "rfc5424"
738+
enum: {
739+
rfc3164: "The legacy RFC3164 syslog format."
740+
rfc5424: "The modern RFC5424 syslog format."
741+
}
742+
}
743+
}
744+
severity: {
745+
description: "Path to a field in the event to use for the severity. Defaults to \"informational\"."
746+
required: false
747+
type: string: {}
748+
}
749+
}
750+
}
699751
timestamp_format: {
700752
description: "Format used for timestamp fields."
701753
required: false

‎website/cue/reference/components/sinks/generated/aws_sns.cue‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,10 @@ generated: components: sinks: aws_sns: configuration: {
333333
transform) and removing the message field while doing additional parsing on it, as this
334334
could lead to the encoding emitting empty strings for the given event.
335335
"""
336+
syslog: """
337+
Syslog encoding
338+
RFC 3164 and 5424 are supported
339+
"""
336340
text: """
337341
Plain text encoding.
338342
@@ -518,6 +522,54 @@ generated: components: sinks: aws_sns: configuration: {
518522
}
519523
}
520524
}
525+
syslog: {
526+
description: "Options for the Syslog serializer."
527+
relevant_when: "codec = \"syslog\""
528+
required: false
529+
type: object: options: {
530+
app_name: {
531+
description: """
532+
Path to a field in the event to use for the app name.
533+
534+
If not provided, the encoder checks for a semantic "service" field.
535+
If that is also missing, it defaults to "vector".
536+
"""
537+
required: false
538+
type: string: {}
539+
}
540+
facility: {
541+
description: "Path to a field in the event to use for the facility. Defaults to \"user\"."
542+
required: false
543+
type: string: {}
544+
}
545+
msg_id: {
546+
description: "Path to a field in the event to use for the msg ID."
547+
required: false
548+
type: string: {}
549+
}
550+
proc_id: {
551+
description: "Path to a field in the event to use for the proc ID."
552+
required: false
553+
type: string: {}
554+
}
555+
rfc: {
556+
description: "RFC to use for formatting."
557+
required: false
558+
type: string: {
559+
default: "rfc5424"
560+
enum: {
561+
rfc3164: "The legacy RFC3164 syslog format."
562+
rfc5424: "The modern RFC5424 syslog format."
563+
}
564+
}
565+
}
566+
severity: {
567+
description: "Path to a field in the event to use for the severity. Defaults to \"informational\"."
568+
required: false
569+
type: string: {}
570+
}
571+
}
572+
}
521573
timestamp_format: {
522574
description: "Format used for timestamp fields."
523575
required: false

0 commit comments

Comments
 (0)