-
Notifications
You must be signed in to change notification settings - Fork 78
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
20 changed files
with
793 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,14 @@ | ||
| # Plugin Configurations | ||
|
|
||
| | key | environment key | default value | description | | ||
| |--------------------------------|-------------------------------------------------------|---------------|----------------------------------------------------------------| | ||
| | http.server_collect_parameters | SW_AGENT_PLUGIN_CONFIG_HTTP_SERVER_COLLECT_PARAMETERS | false | Collect the parameters of the HTTP request on the server side. | | ||
| | mongo.collect_statement | SW_AGENT_PLUGIN_CONFIG_MONGO_COLLECT_STATEMENT | false | Collect the statement of the MongoDB request. | | ||
| | sql.collect_parameter | SW_AGENT_PLUGIN_CONFIG_SQL_COLLECT_PARAMETER | false | Collect the parameter of the SQL request. | | ||
| | redis.max_args_bytes | SW_AGENT_PLUGIN_CONFIG_REDIS_MAX_ARGS_BYTES | 1024 | Limit the bytes size of redis args request. | | ||
| | reporter.discard | SW_AGENT_REPORTER_DISCARD | false | Discard the reporter. | | ||
| | gin.collect_request_headers | SW_AGENT_PLUGIN_CONFIG_GIN_COLLECT_REQUEST_HEADERS | | Collect the http header of gin request. | | ||
| | gin.header_length_threshold | SW_AGENT_PLUGIN_CONFIG_GIN_HEADER_LENGTH_THRESHOLD | 2048 | Controlling the length limitation of all header values. | | ||
| | key | environment key | default value | description | | ||
| |------------------------------------|-----------------------------------------------------------|---------------|----------------------------------------------------------------| | ||
| | http.server_collect_parameters | SW_AGENT_PLUGIN_CONFIG_HTTP_SERVER_COLLECT_PARAMETERS | false | Collect the parameters of the HTTP request on the server side. | | ||
| | mongo.collect_statement | SW_AGENT_PLUGIN_CONFIG_MONGO_COLLECT_STATEMENT | false | Collect the statement of the MongoDB request. | | ||
| | sql.collect_parameter | SW_AGENT_PLUGIN_CONFIG_SQL_COLLECT_PARAMETER | false | Collect the parameter of the SQL request. | | ||
| | redis.max_args_bytes | SW_AGENT_PLUGIN_CONFIG_REDIS_MAX_ARGS_BYTES | 1024 | Limit the bytes size of redis args request. | | ||
| | reporter.discard | SW_AGENT_REPORTER_DISCARD | false | Discard the reporter. | | ||
| | gin.collect_request_headers | SW_AGENT_PLUGIN_CONFIG_GIN_COLLECT_REQUEST_HEADERS | | Collect the http header of gin request. | | ||
| | gin.header_length_threshold | SW_AGENT_PLUGIN_CONFIG_GIN_HEADER_LENGTH_THRESHOLD | 2048 | Controlling the length limitation of all header values. | | ||
| | goframe.collect_request_parameters | SW_AGENT_PLUGIN_CONFIG_GOFRAME_COLLECT_REQUEST_PARAMETERS | false | Collect the parameters of the HTTP request on the server side. | | ||
| | goframe.collect_request_headers | SW_AGENT_PLUGIN_CONFIG_GOFRAME_COLLECT_REQUEST_HEADERS | | Collect the http header of goframe request. | | ||
| | goframe.header_length_threshold | SW_AGENT_PLUGIN_CONFIG_GOFRAME_HEADER_LENGTH_THRESHOLD | 2048 | Controlling the length limitation of all header values. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| module github.com/apache/skywalking-go/plugins/goframe | ||
|
|
||
| go 1.19 | ||
|
|
||
| require ( | ||
| github.com/dave/dst v0.27.2 // indirect | ||
| github.com/stretchr/testify v1.9.0 // indirect | ||
| golang.org/x/sys v0.20.0 // indirect | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| github.com/apache/skywalking-go/plugins/core v0.0.0-20240910044646-4f94a255c2d3 h1:eU6k2oVqIeHt0qoExrP5OsvNF3+29dXBR9DFVJS56hM= | ||
| github.com/apache/skywalking-go/plugins/core v0.0.0-20240910044646-4f94a255c2d3/go.mod h1:5a8UbX22PEo+7u7aPvGyNVDPkkJHM//nZwrnk7TDXIM= | ||
| github.com/dave/dst v0.27.2 h1:4Y5VFTkhGLC1oddtNwuxxe36pnyLxMFXT51FOzH8Ekc= | ||
| github.com/dave/dst v0.27.2/go.mod h1:jHh6EOibnHgcUW3WjKHisiooEkYwqpHLBSX1iOBhEyc= | ||
| github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= | ||
| github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= | ||
| github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= | ||
| github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= | ||
| golang.org/x/mod v0.9.0 h1:KENHtAZL2y3NLMYZeHY9DW8HW8V+kQyJsY/V9JlKvCs= | ||
| golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y= | ||
| golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= | ||
| golang.org/x/tools v0.7.0 h1:W4OVu8VVOaIO0yzWMNdepAulS7YfoS3Zabrm8DOXXU4= | ||
| gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| // Licensed to Apache Software Foundation (ASF) under one or more contributor | ||
| // license agreements. See the NOTICE file distributed with | ||
| // this work for additional information regarding copyright | ||
| // ownership. Apache Software Foundation (ASF) licenses this file to you 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 goframe | ||
|
|
||
| //go:nolint | ||
| import ( | ||
| "embed" | ||
| "strings" | ||
|
|
||
| "github.com/apache/skywalking-go/plugins/core/instrument" | ||
| ) | ||
|
|
||
| //go:embed * | ||
| var fs embed.FS | ||
|
|
||
| //skywalking:nocopy | ||
| type Instrument struct { | ||
| } | ||
|
|
||
| func NewInstrument() *Instrument { | ||
| return &Instrument{} | ||
| } | ||
|
|
||
| func (i *Instrument) Name() string { | ||
| return "goframe" | ||
| } | ||
|
|
||
| func (i *Instrument) BasePackage() string { | ||
| return "github.com/gogf/gf/v2" | ||
| } | ||
|
|
||
| func (i *Instrument) VersionChecker(version string) bool { | ||
| return strings.HasPrefix(version, "v2.") | ||
| } | ||
|
|
||
| func (i *Instrument) Points() []*instrument.Point { | ||
| return []*instrument.Point{ | ||
| { | ||
| PackagePath: "net/ghttp", | ||
| At: instrument.NewMethodEnhance("*Server", "ServeHTTP", | ||
| instrument.WithArgsCount(2), instrument.WithArgType(0, "http.ResponseWriter"), | ||
| instrument.WithArgType(1, "*http.Request")), | ||
| Interceptor: "GoFrameServerInterceptor", | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func (i *Instrument) FS() *embed.FS { | ||
| return &fs | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| // Licensed to Apache Software Foundation (ASF) under one or more contributor | ||
| // license agreements. See the NOTICE file distributed with | ||
| // this work for additional information regarding copyright | ||
| // ownership. Apache Software Foundation (ASF) licenses this file to you 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 ghttp | ||
|
|
||
| //skywalking:config goframe | ||
| var config struct { | ||
| CollectRequestParameters bool `config:"collect_request_parameters"` | ||
| CollectRequestHeaders []string `config:"collect_request_headers"` | ||
| HeaderLengthThreshold int `config:"header_length_threshold"` | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| // Licensed to Apache Software Foundation (ASF) under one or more contributor | ||
| // license agreements. See the NOTICE file distributed with | ||
| // this work for additional information regarding copyright | ||
| // ownership. Apache Software Foundation (ASF) licenses this file to you 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 ghttp | ||
|
|
||
| // nolint | ||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "strings" | ||
|
|
||
| "github.com/apache/skywalking-go/plugins/core/operator" | ||
| "github.com/apache/skywalking-go/plugins/core/tracing" | ||
| ) | ||
|
|
||
| // GoFrameServerInterceptor is used to intercept and trace HTTP requests. | ||
| type GoFrameServerInterceptor struct{} | ||
|
|
||
| // BeforeInvoke intercepts the HTTP request before invoking the handler. | ||
| func (h *GoFrameServerInterceptor) BeforeInvoke(invocation operator.Invocation) error { | ||
| request := invocation.Args()[1].(*http.Request) | ||
| s, err := tracing.CreateEntrySpan(fmt.Sprintf("%s:%s", request.Method, request.URL.Path), func(headerKey string) (string, error) { | ||
| return request.Header.Get(headerKey), nil | ||
| }, tracing.WithLayer(tracing.SpanLayerHTTP), | ||
| tracing.WithTag(tracing.TagHTTPMethod, request.Method), | ||
| tracing.WithTag(tracing.TagURL, request.Host+request.URL.Path), | ||
| tracing.WithComponent(5022)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if config.CollectRequestParameters && request.URL != nil { | ||
| s.Tag(tracing.TagHTTPParams, request.URL.RawQuery) | ||
| } | ||
| if len(config.CollectRequestHeaders) > 0 { | ||
| collectRequestHeaders(s, request.Header) | ||
| } | ||
|
|
||
| writer := invocation.Args()[0].(http.ResponseWriter) | ||
| invocation.ChangeArg(0, &writerWrapper{ResponseWriter: writer, statusCode: http.StatusOK}) | ||
| invocation.SetContext(s) | ||
| return nil | ||
| } | ||
|
|
||
| // AfterInvoke processes after the HTTP request has been handled. | ||
| func (h *GoFrameServerInterceptor) AfterInvoke(invocation operator.Invocation, result ...interface{}) error { | ||
| if invocation.GetContext() == nil { | ||
| return nil | ||
| } | ||
| span := invocation.GetContext().(tracing.Span) | ||
| if wrapped, ok := invocation.Args()[0].(*writerWrapper); ok { | ||
| span.Tag(tracing.TagStatusCode, fmt.Sprintf("%d", wrapped.statusCode)) | ||
| } | ||
| span.End() | ||
| return nil | ||
| } | ||
|
|
||
| type writerWrapper struct { | ||
| http.ResponseWriter | ||
| statusCode int | ||
| } | ||
|
|
||
| func collectRequestHeaders(span tracing.Span, requestHeaders http.Header) { | ||
| var headerTagValues []string | ||
| for _, header := range config.CollectRequestHeaders { | ||
| var headerValue = requestHeaders.Get(header) | ||
| if headerValue != "" { | ||
| headerTagValues = append(headerTagValues, header+"="+headerValue) | ||
| } | ||
| } | ||
|
|
||
| if len(headerTagValues) == 0 { | ||
| return | ||
| } | ||
|
|
||
| tagValue := strings.Join(headerTagValues, "\n") | ||
| if len(tagValue) > config.HeaderLengthThreshold { | ||
| maxLen := config.HeaderLengthThreshold | ||
| tagValue = tagValue[:maxLen] | ||
| } | ||
|
|
||
| span.Tag(tracing.TagHTTPHeaders, tagValue) | ||
| } |
Oops, something went wrong.