github.com/braveheart12/just@v0.8.7/metrics/doc.go (about) 1 /* 2 * Copyright 2019 Insolar Technologies 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 /* 18 Package metrics is a gateway for Prometheus monitoring system, it based on Prometheus golang client. 19 Package contains metrics collectors descriptions of entire project. 20 Component starts http server on http://0.0.0.0:8080/metrics by default(can be changed in configuration) 21 22 Example: 23 24 // starts metrics server 25 cfg := configuration.NewMetrics() 26 m, _ := NewMetrics(cfg) 27 m.Start(nil) 28 29 // manipulate with network metrics 30 NetworkMessageSentTotal.Inc() 31 NetworkPacketSentTotal.WithLabelValues("ping").Add(55) 32 33 */ 34 package metrics