profiling.go 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. /*
  2. *
  3. * Copyright 2019 gRPC authors.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. *
  17. */
  18. // Package profiling exposes methods to manage profiling within gRPC.
  19. //
  20. // # Experimental
  21. //
  22. // Notice: This package is EXPERIMENTAL and may be changed or removed in a
  23. // later release.
  24. package profiling
  25. import (
  26. internal "google.golang.org/grpc/internal/profiling"
  27. )
  28. // Enable turns profiling on and off. This operation is safe for concurrent
  29. // access from different goroutines.
  30. //
  31. // Note that this is the only operation that's accessible through the publicly
  32. // exposed profiling package. Everything else (such as retrieving stats) must
  33. // be done through the profiling service. This is allowed so that users can use
  34. // heuristics to turn profiling on and off automatically.
  35. func Enable(enabled bool) {
  36. internal.Enable(enabled)
  37. }