-
Notifications
You must be signed in to change notification settings - Fork 74
/
envelope.go
81 lines (70 loc) · 2.29 KB
/
envelope.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
// Copyright 2015-2017 trivago GmbH
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package format
import (
"github.com/trivago/gollum/core"
)
// Envelope formatter
//
// This formatter adds content to the beginning and/or end of a message.
//
// Parameters
//
// - Prefix: Defines a string that is added to the front of the message.
// Special characters like \n \r or \t can be used without additional escaping.
// By default this parameter is set to "".
//
// - Postfix: Defines a string that is added to the end of the message.
// Special characters like \n \r or \t can be used without additional escaping.
// By default this parameter is set to "\n".
//
// Examples
//
// This example adds a line number and a newline character to each message
// printed to the console.
//
// exampleProducer:
// Type: producer.Console
// Streams: "*"
// Modulators:
// - format.Sequence
// - format.Envelope
type Envelope struct {
core.SimpleFormatter `gollumdoc:"embed_type"`
postfix string `config:"Postfix" default:"\n"`
prefix string `config:"Prefix"`
}
func init() {
core.TypeRegistry.Register(Envelope{})
}
// Configure initializes this formatter with values from a plugin config.
func (format *Envelope) Configure(conf core.PluginConfigReader) {
}
// ApplyFormatter update message payload
func (format *Envelope) ApplyFormatter(msg *core.Message) error {
prefixLen := len(format.prefix)
postfixLen := len(format.postfix)
content := format.GetAppliedContent(msg)
offset := 0
payload := core.MessageDataPool.Get(prefixLen + len(content) + postfixLen)
if prefixLen > 0 {
offset = copy(payload, format.prefix)
}
offset += copy(payload[offset:], content)
if postfixLen > 0 {
copy(payload[offset:], format.postfix)
}
format.SetAppliedContent(msg, payload)
return nil
}