Skip to content

Commit f61dbea

Browse files
committed
Update doc comment of NewProcessCollector
- Now also works on MS Windows. - The hints for updating from older versions is obsolete by now. Signed-off-by: beorn7 <[email protected]>
1 parent c5f4190 commit f61dbea

File tree

1 file changed

+3
-14
lines changed

1 file changed

+3
-14
lines changed

prometheus/process_collector.go

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,20 +57,9 @@ type ProcessCollectorOpts struct {
5757
// collector for the current process with an empty namespace string and no error
5858
// reporting.
5959
//
60-
// Currently, the collector depends on a Linux-style proc filesystem and
61-
// therefore only exports metrics for Linux.
62-
//
63-
// Note: An older version of this function had the following signature:
64-
//
65-
// NewProcessCollector(pid int, namespace string) Collector
66-
//
67-
// Most commonly, it was called as
68-
//
69-
// NewProcessCollector(os.Getpid(), "")
70-
//
71-
// The following call of the current version is equivalent to the above:
72-
//
73-
// NewProcessCollector(ProcessCollectorOpts{})
60+
// The collector only works on operating systems with a Linux-style proc
61+
// filesystem and on Microsoft Windows. On other operating systems, it will not
62+
// collect any metrics.
7463
func NewProcessCollector(opts ProcessCollectorOpts) Collector {
7564
ns := ""
7665
if len(opts.Namespace) > 0 {

0 commit comments

Comments
 (0)