Skip to content

Commit

Permalink
Add pprof http service and demote prom interceptor to not run by defa…
Browse files Browse the repository at this point in the history
…ult (#4508)

* add pprof http service
* disable loading prom as default interceptor
  • Loading branch information
labkode authored Feb 7, 2024
1 parent 583fd2c commit ce0bd1e
Show file tree
Hide file tree
Showing 4 changed files with 87 additions and 2 deletions.
6 changes: 6 additions & 0 deletions changelog/unreleased/pprof.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Enhancement: Add pprof http service

This service is useful to trigger diagnostics
on running processes

https://github.com/cs3org/reva/pull/4508
2 changes: 0 additions & 2 deletions cmd/revad/runtime/http.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import (
"github.com/cs3org/reva/internal/http/interceptors/appctx"
"github.com/cs3org/reva/internal/http/interceptors/auth"
"github.com/cs3org/reva/internal/http/interceptors/log"
"github.com/cs3org/reva/internal/http/interceptors/metrics"
"github.com/cs3org/reva/internal/http/interceptors/trace"
"github.com/cs3org/reva/pkg/rhttp/global"
"github.com/pkg/errors"
Expand Down Expand Up @@ -72,7 +71,6 @@ func initHTTPMiddlewares(conf map[string]map[string]any, unprotected []string, l
authMiddle,
log.New(),
appctx.New(*logger),
metrics.New(),
trace.New(),
}

Expand Down
1 change: 1 addition & 0 deletions internal/http/services/loader/loader.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ import (
_ "github.com/cs3org/reva/internal/http/services/owncloud/ocs"
_ "github.com/cs3org/reva/internal/http/services/pingpong"
_ "github.com/cs3org/reva/internal/http/services/plugins"
_ "github.com/cs3org/reva/internal/http/services/pprof"
_ "github.com/cs3org/reva/internal/http/services/preferences"
_ "github.com/cs3org/reva/internal/http/services/prometheus"
_ "github.com/cs3org/reva/internal/http/services/reverseproxy"
Expand Down
80 changes: 80 additions & 0 deletions internal/http/services/pprof/pprof.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
// Copyright 2018-2024 CERN
//
// 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.
//
// In applying this license, CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.

package pprof

import (
"context"
"net/http"
"net/http/pprof"

"github.com/cs3org/reva/pkg/rhttp/global"
"github.com/cs3org/reva/pkg/utils/cfg"
)

func init() {
global.Register("pprof", New)
}

// New returns a new pprof service.
func New(ctx context.Context, m map[string]interface{}) (global.Service, error) {
var c config
if err := cfg.Decode(m, &c); err != nil {
return nil, err
}

c.ApplyDefaults()

return &svc{conf: &c}, nil
}

// Close performs cleanup.
func (s *svc) Close() error {
return nil
}

type config struct {
Prefix string `mapstructure:"prefix"`
}

func (c *config) ApplyDefaults() {
// pprof is always exposed at /debug
c.Prefix = "debug"
}

type svc struct {
conf *config
}

func (s *svc) Prefix() string {
return s.conf.Prefix
}

func (s *svc) Unprotected() []string {
return []string{"/"}
}

func (s *svc) Handler() http.Handler {
mux := http.NewServeMux()
// example: /debug/pprof/profile
mux.HandleFunc("/pprof/", pprof.Index)
mux.HandleFunc("/pprof/profile", pprof.Profile)
mux.HandleFunc("/pprof/symbol", pprof.Symbol)
mux.HandleFunc("/pprof/trace", pprof.Trace)
return mux
}

0 comments on commit ce0bd1e

Please sign in to comment.