initial checkin
This commit is contained in:
commit
3198b7d802
|
@ -0,0 +1,202 @@
|
|||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
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.
|
|
@ -0,0 +1,56 @@
|
|||
dahid2prometheus - a prometheus exporter for DAHDI
|
||||
==================================================
|
||||
|
||||
This is a small project in the `go` programming language, obtaining DAHDI
|
||||
statistic via the DAHDI_SPANSTAT ioctl() and exposing the data in
|
||||
prometheus exporter syntax over HTTP for prometheus to collect/scrape
|
||||
them.
|
||||
|
||||
It's almost my first go project, and I had the basics put together in
|
||||
about 30mins. Your mileage may vary!
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
```
|
||||
Usage of dahdi2prometheus:
|
||||
-http string
|
||||
local HTTP listen host:port (default ":2113")
|
||||
```
|
||||
|
||||
So you simply run the dahdi2prometheus somewhere and
|
||||
|
||||
* tell it on which HTTP port to listen for prometheus to scrape
|
||||
* configure prometheus to actually scrape with a section as stated below
|
||||
|
||||
```
|
||||
scrape_configs:
|
||||
- job_name: dahdi
|
||||
static_configs:
|
||||
- targets: ['hostname:2113']
|
||||
```
|
||||
|
||||
Grafana
|
||||
-------
|
||||
|
||||
There's a [sample grafana dashboard](grafana-dashboard/dahdi.json)
|
||||
|
||||
![sample grafana dashboard](grafana-dashboard/grafana-dahdi-dashboard.png?raw=true "grafana dashboard for DAHDI")
|
||||
|
||||
Credits
|
||||
-------
|
||||
|
||||
All the real workhorse code behind this project is in the following
|
||||
upstream libraries I'm using:
|
||||
|
||||
* [prometheus/client_golang](https://github.com/prometheus/client_golang)
|
||||
|
||||
This project is just gluing together the above two libraries.
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
I'm usually much more in favor of copyleft licenses, but given the two
|
||||
libraries I use are MIT and Apache 2.0, I decided to go for a permissive
|
||||
license in this project, too. So the code is released under Apache 2.0,
|
||||
see the [COPYING](COPYING) file for details.
|
|
@ -0,0 +1,265 @@
|
|||
// (C) 2022 by Harald Welte <laforge@gnumonks.org>
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
package main
|
||||
|
||||
/*
|
||||
#include <dahdi/user.h>
|
||||
*/
|
||||
import "C"
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"flag"
|
||||
"unsafe"
|
||||
"syscall"
|
||||
"acln.ro/ioctl"
|
||||
|
||||
"net/http"
|
||||
"github.com/prometheus/client_golang/prometheus"
|
||||
"github.com/prometheus/client_golang/prometheus/promauto"
|
||||
"github.com/prometheus/client_golang/prometheus/promhttp"
|
||||
)
|
||||
|
||||
var (
|
||||
listen_http = flag.String("http",":2113", "local HTTP listen host:port")
|
||||
dahdi_ctl int
|
||||
|
||||
spanno = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_span_number",
|
||||
Help: "span number of this span",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
txlevel = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_txlevel",
|
||||
Help: "current Tx Level",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
rxlevel = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_rxlevel",
|
||||
Help: "current Rx Level",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
bpvcount = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_bpv_error_total",
|
||||
Help: "current BPV (bi-polar violation) count",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
crc4count = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_crc4_error_total",
|
||||
Help: "current CRC4 error count",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
ebitcount = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_ebit_error_total",
|
||||
Help: "current E-bit error count",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
fascount = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_fas_error_total",
|
||||
Help: "current FAS error count",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
fecount = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_framing_error_total",
|
||||
Help: "current framing error count",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
cvcount = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_coding_violation_total",
|
||||
Help: "current coding violation error count",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
becount = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_bit_error_total",
|
||||
Help: "current bit error count",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
prbs = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_prbs",
|
||||
Help: "current PRBS detected pattern",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
errsec = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_errored_seconds",
|
||||
Help: "errored seconds",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
irqmisses = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_irq_misses_total",
|
||||
Help: "current IRQ misses",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
syncsrc = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_sync_source_span",
|
||||
Help: "span number of current sync source",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
numchans = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_channels_configured_total",
|
||||
Help: "number of configured channels in this span",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
|
||||
|
||||
totalchans = promauto.NewGaugeVec(
|
||||
prometheus.GaugeOpts {
|
||||
Subsystem: "dahdi",
|
||||
Name: "spaninfo_channels_total",
|
||||
Help: "number of channels in this span",
|
||||
},
|
||||
[]string{
|
||||
"span_name",
|
||||
})
|
||||
)
|
||||
|
||||
/* report one span to prometheus */
|
||||
func report_span(spaninfo *C.struct_dahdi_spaninfo) {
|
||||
name := C.GoString(&spaninfo.name[0])
|
||||
spanno.WithLabelValues(name).Set(float64(spaninfo.spanno))
|
||||
txlevel.WithLabelValues(name).Set(float64(spaninfo.txlevel))
|
||||
rxlevel.WithLabelValues(name).Set(float64(spaninfo.rxlevel))
|
||||
bpvcount.WithLabelValues(name).Set(float64(spaninfo.bpvcount))
|
||||
crc4count.WithLabelValues(name).Set(float64(spaninfo.crc4count))
|
||||
ebitcount.WithLabelValues(name).Set(float64(spaninfo.ebitcount))
|
||||
fascount.WithLabelValues(name).Set(float64(spaninfo.fascount))
|
||||
fecount.WithLabelValues(name).Set(float64(spaninfo.fecount))
|
||||
cvcount.WithLabelValues(name).Set(float64(spaninfo.cvcount))
|
||||
becount.WithLabelValues(name).Set(float64(spaninfo.becount))
|
||||
prbs.WithLabelValues(name).Set(float64(spaninfo.prbs))
|
||||
errsec.WithLabelValues(name).Set(float64(spaninfo.errsec))
|
||||
irqmisses.WithLabelValues(name).Set(float64(spaninfo.irqmisses))
|
||||
syncsrc.WithLabelValues(name).Set(float64(spaninfo.syncsrc))
|
||||
numchans.WithLabelValues(name).Set(float64(spaninfo.numchans))
|
||||
totalchans.WithLabelValues(name).Set(float64(spaninfo.totalchans))
|
||||
}
|
||||
|
||||
/* read spanstat of one span */
|
||||
func read_span(spaninfo *C.struct_dahdi_spaninfo) {
|
||||
var spanstat ioctl.WR
|
||||
//var spaninfo C.struct_dahdi_spaninfo
|
||||
var err error
|
||||
|
||||
spanstat.Name = "DAHDI Spaninfo"
|
||||
spanstat.Type = 0xDA
|
||||
spanstat.Nr = 10
|
||||
spanstat.Size = uint16(unsafe.Sizeof(*spaninfo))
|
||||
|
||||
fmt.Println("SPANSTAT ioctl on span ", spaninfo)
|
||||
if err = spanstat.Exec(dahdi_ctl, unsafe.Pointer(spaninfo)); err != nil {
|
||||
fmt.Println("spaninfo ", spaninfo)
|
||||
panic(fmt.Sprintf("Failed to execute ioctl: %s", err))
|
||||
}
|
||||
}
|
||||
|
||||
/* iterate over all spans, read + report each of them */
|
||||
func read_spans() {
|
||||
var spaninfo C.struct_dahdi_spaninfo
|
||||
//var err error
|
||||
|
||||
/* first obtain the total number of spans */
|
||||
spaninfo.spanno = 1
|
||||
read_span(&spaninfo)
|
||||
report_span(&spaninfo)
|
||||
total_spans := int(spaninfo.totalspans)
|
||||
|
||||
/* then iterate over the remainder of them */
|
||||
for i := 2; i <= total_spans; i++ {
|
||||
spaninfo.spanno = C.int(i)
|
||||
read_span(&spaninfo)
|
||||
report_span(&spaninfo)
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
func main() {
|
||||
var err error
|
||||
|
||||
flag.Parse()
|
||||
|
||||
if dahdi_ctl, err = syscall.Open("/dev/dahdi/ctl", syscall.O_RDWR, 0775); err != nil {
|
||||
panic(fmt.Sprintf("Failed to open DAHDI ctl: %s", err))
|
||||
}
|
||||
|
||||
read_spans()
|
||||
|
||||
fmt.Println("Listening to HTTP requests at", *listen_http)
|
||||
http.Handle("/metrics", promhttp.Handler())
|
||||
http.ListenAndServe(*listen_http, nil)
|
||||
|
||||
|
||||
}
|
|
@ -0,0 +1,17 @@
|
|||
module laf0rge/dahdi2prometheus
|
||||
|
||||
go 1.19
|
||||
|
||||
require (
|
||||
acln.ro/ioctl v0.10.0 // indirect
|
||||
github.com/beorn7/perks v1.0.1 // indirect
|
||||
github.com/cespare/xxhash/v2 v2.1.2 // indirect
|
||||
github.com/golang/protobuf v1.5.2 // indirect
|
||||
github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
|
||||
github.com/prometheus/client_golang v1.14.0 // indirect
|
||||
github.com/prometheus/client_model v0.3.0 // indirect
|
||||
github.com/prometheus/common v0.37.0 // indirect
|
||||
github.com/prometheus/procfs v0.8.0 // indirect
|
||||
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a // indirect
|
||||
google.golang.org/protobuf v1.28.1 // indirect
|
||||
)
|
Loading…
Reference in New Issue