CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(inputs.phpfpm): Use logger without causing panic (#14489) 

Signed-off-by: elchenberg <elchenberg@users.noreply.github.com>
This commit is contained in:
Helge Eichelberg 2024-01-02 18:33:39 +01:00 committed by GitHub
parent 2c7c52481d
commit 1eb86dc93b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 36 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/inputs/phpfpm/phpfpm.go
View File

@ -83,7 +83,7 @@ type phpfpm struct {
tls.ClientConfig
client *http.Client
log telegraf.Logger
Log telegraf.Logger
}
func (*phpfpm) SampleConfig() string {
@ -300,7 +300,7 @@ func parseLines(r io.Reader, acc telegraf.Accumulator, addr string) {
func (p *phpfpm) parseJSON(r io.Reader, acc telegraf.Accumulator, addr string) {
var metrics JSONMetrics
if err := json.NewDecoder(r).Decode(&metrics); err != nil {
p.log.Errorf("Unable to decode JSON response: %s", err)
p.Log.Errorf("Unable to decode JSON response: %s", err)
return
}
timestamp := time.Now()

37
plugins/inputs/phpfpm/phpfpm_test.go
View File

@ -6,9 +6,12 @@
package phpfpm
import (
"bytes"
"crypto/rand"
_ "embed"
"encoding/binary"
"fmt"
"log"
"net"
"net/http"
"net/http/fcgi"
@ -19,6 +22,7 @@ import (
"github.com/stretchr/testify/require"
"github.com/influxdata/telegraf/plugins/common/shim"
"github.com/influxdata/telegraf/plugins/parsers/influx"
"github.com/influxdata/telegraf/testutil"
)
@ -76,8 +80,6 @@ func TestPhpFpmGeneratesMetrics_From_Http(t *testing.T) {
}
func TestPhpFpmGeneratesJSONMetrics_From_Http(t *testing.T) {
outputSampleJSON, err := os.ReadFile("testdata/phpfpm.json")
require.NoError(t, err)
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "text/json")
w.Header().Set("Content-Length", strconv.Itoa(len(outputSampleJSON)))
@ -94,7 +96,7 @@ func TestPhpFpmGeneratesJSONMetrics_From_Http(t *testing.T) {
input := &phpfpm{
Urls: []string{server.URL + "?full&json"},
Format: "json",
log: testutil.Logger{},
Log: testutil.Logger{},
}
require.NoError(t, input.Init())
@ -358,3 +360,32 @@ max active processes: 1
max children reached: 2
slow requests: 1
`
//go:embed testdata/phpfpm.json
var outputSampleJSON []byte
func TestPhpFpmParseJSON_Log_Error_Without_Panic_When_When_JSON_Is_Invalid(t *testing.T) {
p := &phpfpm{}
// AddInput sets the Logger
if err := shim.New().AddInput(p); err != nil {
t.Error(err)
return
}
// capture log output
var logOutput bytes.Buffer
log.SetOutput(&logOutput)
defer func() {
log.SetOutput(os.Stderr)
}()
// parse valid JSON without panic and without log output
validJSON := outputSampleJSON
require.NotPanics(t, func() { p.parseJSON(bytes.NewReader(validJSON), &testutil.NopAccumulator{}, "") })
require.Equal(t, "", logOutput.String())
// parse invalid JSON without panic but with log output
invalidJSON := []byte("X")
require.NotPanics(t, func() { p.parseJSON(bytes.NewReader(invalidJSON), &testutil.NopAccumulator{}, "") })
require.Contains(t, logOutput.String(), "E! Unable to decode JSON response: invalid character 'X' looking for beginning of value")
}