initial commit
This commit is contained in:
Anry Das
commit
954f607c5a
6
.dockerignore
Executable file
6
.dockerignore
Executable file
@ -0,0 +1,6 @@
|
|||||||
|
.idea
|
||||||
|
.venv
|
||||||
|
__pycache__
|
||||||
|
data
|
||||||
|
.dockerignore
|
||||||
|
Dockerfile
|
||||||
0
.gitignore
vendored
Normal file
0
.gitignore
vendored
Normal file
17
Dockerfile
Executable file
17
Dockerfile
Executable file
@ -0,0 +1,17 @@
|
|||||||
|
FROM python:3.13-alpine
|
||||||
|
|
||||||
|
MAINTAINER -=:dAs:=-
|
||||||
|
|
||||||
|
RUN apk add gcc python3-dev musl-dev linux-headers
|
||||||
|
|
||||||
|
WORKDIR /usr/src/app
|
||||||
|
|
||||||
|
COPY requirements.txt ./
|
||||||
|
RUN pip install --no-cache-dir -r requirements.txt
|
||||||
|
|
||||||
|
COPY *.py .
|
||||||
|
COPY metrics/*.py metrics/
|
||||||
|
|
||||||
|
EXPOSE 15200
|
||||||
|
|
||||||
|
CMD [ "python", "./main.py" ]
|
||||||
674
LICENSE
Normal file
674
LICENSE
Normal file
@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
230
README.md
Normal file
230
README.md
Normal file
@ -0,0 +1,230 @@
|
|||||||
|
## Das Simple Exporter
|
||||||
|
### _Das Simple metrics Exporter for Prometheus_
|
||||||
|
|
||||||
|
[](https://www.python.org) [](https://prometheus.io/) [](https://grafana.com/) [](https://www.docker.com/)
|
||||||
|
|
||||||
|
### 💡 Purpose
|
||||||
|
Create configurable lightweight application to collect some metrics
|
||||||
|
|
||||||
|
### 📃 Features
|
||||||
|
- lightweight and system resources friendly
|
||||||
|
- [configurable application](#AppConfig)
|
||||||
|
- [configurable metrics](#MetricsConfig) to be collected
|
||||||
|
- supported several [metric types](#MetricTypes)
|
||||||
|
- hot reload metrics if configuration changed
|
||||||
|
- could be used as [regular application](#StartRegular), as [systemctl service](#StartService) or a [Docker application](#StartDocker)
|
||||||
|
- supports JSON, PROPERTIES and YAML configuration formats
|
||||||
|
|
||||||
|
### 📌 Using
|
||||||
|
_To use specific configuration format the `app_config.CONFIG_FILE_NAME` variable need to be changed. The default config file format is **JSON**_
|
||||||
|
|
||||||
|
#### Application Configuration <a id='AppConfig' />
|
||||||
|
Default config stored in `./configs/` directory in Application dir. To change its location the `app_config.CONFIGS_DIR` variable need to be changed.
|
||||||
|
|
||||||
|
**_Application config changes to take effect the application need to be restarted._**
|
||||||
|
|
||||||
|
The Default Application config is:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"monitor": {
|
||||||
|
"config": {
|
||||||
|
"debug": "false",
|
||||||
|
"print_info": "false",
|
||||||
|
"interval_seconds": 30,
|
||||||
|
"uptime_update_seconds": 60,
|
||||||
|
"port": 15200,
|
||||||
|
"stop_file_name": "/stop",
|
||||||
|
"response_path_separator": "|"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
- `debug` and `print_info` values need for debug purpose and used to output the debugging information into standard output.
|
||||||
|
- `interval_seconds` - metrics update time in seconds. Indicates how often every metric will be touch to check if its need to be updated. Every metric have its own update interval.
|
||||||
|
- `uptime_update_seconds` - the Application uptime metric update interval in seconds.
|
||||||
|
- `port` - port on which the Exporter's service to be started
|
||||||
|
- `stop_file_name` - if this file name appears in application's directory the Application will be stopped.
|
||||||
|
- `response_path_separator` - the response path separator. Used in `rest_value` metric configuration.
|
||||||
|
|
||||||
|
#### Metrics Configuration<a id='MetricsConfig' />
|
||||||
|
There are some embedded metrics in the Exporter:
|
||||||
|
- Exporter uptime
|
||||||
|
- System uptime
|
||||||
|
- CPU used percents
|
||||||
|
- Memory used percents
|
||||||
|
- Chassis temperature
|
||||||
|
- CPU temperature
|
||||||
|
|
||||||
|
The Default Application config is (no metrics are configured):
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"monitor": {
|
||||||
|
"instance_prefix": "",
|
||||||
|
"metrics": {
|
||||||
|
"disk": [],
|
||||||
|
"health": [],
|
||||||
|
"ping": [],
|
||||||
|
"iface": [],
|
||||||
|
"rest_value": [],
|
||||||
|
"shell_value": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
`instance_prefix` - prefix that identifies Instance the Exporter launched on. It used to [create the Metric name](#MetricName). May be empty.
|
||||||
|
|
||||||
|
<a id='MetricTypes' />**The Exporter supports following types of metrics:**
|
||||||
|
**Common parameters:**
|
||||||
|
- `name` - parameter used in every metric to identify it. **Required**.
|
||||||
|
- `interval` - time interval in seconds the metric will be updated. **Required**.
|
||||||
|
|
||||||
|
#### Disk (or mount point) Metrics<a id='DiscMetrics' />
|
||||||
|
**_Monitors the Mount Point's sizes: `total`, `used`, `free` space in bytes_**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "root",
|
||||||
|
"path": "/",
|
||||||
|
"interval": 20
|
||||||
|
}
|
||||||
|
```
|
||||||
|
- `path` - FS path to mount point which size will be monitored
|
||||||
|
|
||||||
|
#### Service Health Metrics
|
||||||
|
**_Monitors the Service's Health by http request: if 200 code in response - the service is `up`, otherwise - the service is `dn`_**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "google",
|
||||||
|
"url": "https://google.com",
|
||||||
|
"method": "GET",
|
||||||
|
"auth": {
|
||||||
|
"user": "",
|
||||||
|
"pass": ""
|
||||||
|
},
|
||||||
|
"headers": {
|
||||||
|
"d1": "d1",
|
||||||
|
"d2": "d2"
|
||||||
|
},
|
||||||
|
"interval": 30,
|
||||||
|
"timeout": 1
|
||||||
|
}
|
||||||
|
```
|
||||||
|
- `url` - URL to be monitored
|
||||||
|
- `methd` - method to send request
|
||||||
|
- `auth` - authentication section. Optional
|
||||||
|
- `user` - user name
|
||||||
|
- `pass` - user password
|
||||||
|
- `headers` - http headers section to be sent to the host. Optional. The header's key-value pairs will be sent as is.
|
||||||
|
- `timeout` - timeout to wait for response
|
||||||
|
|
||||||
|
#### ICMP (Ping) Metrics
|
||||||
|
**_Monitors the Host Health by `ping` command: if ip address reachable - the service is `up`, otherwise - the service is `dn`_**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "Router",
|
||||||
|
"ip": "192.168.0.1",
|
||||||
|
"interval": 30,
|
||||||
|
"count": 1
|
||||||
|
}
|
||||||
|
```
|
||||||
|
- `ip` - IP Address or DNS name of the host
|
||||||
|
- `count` - pings count
|
||||||
|
|
||||||
|
#### Network Interface Metrics
|
||||||
|
**_Monitors the Network Interface metrics: send and receive bytes_**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "Eth0",
|
||||||
|
"iface": "eth0",
|
||||||
|
"interval": 15
|
||||||
|
}
|
||||||
|
```
|
||||||
|
- `iface` - system name of network interface (i.e. `eth0`, `lo0`, `wlp4s0`, etc.)
|
||||||
|
|
||||||
|
#### REST value Metrics
|
||||||
|
**_Gets the responses value from http request to REST service_**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "MyService",
|
||||||
|
"url": "http://localhost:8080/api/v1/api",
|
||||||
|
"method": "POST",
|
||||||
|
"auth": {
|
||||||
|
"user": "",
|
||||||
|
"pass": ""
|
||||||
|
},
|
||||||
|
"headers": {
|
||||||
|
"d1": "d1",
|
||||||
|
"d2": "d2"
|
||||||
|
},
|
||||||
|
"result_type": "single",
|
||||||
|
"result_path": "result",
|
||||||
|
"interval": 30,
|
||||||
|
"timeout": 2
|
||||||
|
}
|
||||||
|
```
|
||||||
|
- `url` - URL to be monitored
|
||||||
|
- `methd` - method to send request
|
||||||
|
- `auth` - authentication section. Optional
|
||||||
|
- `user` - user name
|
||||||
|
- `pass` - user password
|
||||||
|
- `headers` - http headers section to be sent to the host. Optional. The header's key-value pairs will be sent as is.
|
||||||
|
- `result_type` - type of result. The `single` type supported yet.
|
||||||
|
- `result_path` - path to result value in response JSON separated by `app_config.RESPONSE_PATH_SEPARATOR` character. Could be configured in [Application config](#AppConfig).
|
||||||
|
- `timeout` - timeout to wait for response
|
||||||
|
|
||||||
|
#### Shell value Metrics
|
||||||
|
**_Gets the shell command executed result value_**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "shell",
|
||||||
|
"command": "echo",
|
||||||
|
"args": [3],
|
||||||
|
"interval": 5
|
||||||
|
}
|
||||||
|
```
|
||||||
|
- `command` - command to be executed
|
||||||
|
- `args` - CLI arguments to be provided to the command
|
||||||
|
In example above the metric will return integer value 3.
|
||||||
|
|
||||||
|
<a id='MetricName' />**The metric name creates as follows:**
|
||||||
|
- uses Metric Prefix, actually `das_`
|
||||||
|
- uses `metric_text` given to every metric while it creating
|
||||||
|
- uses `instance_prefix` given in metric configuration
|
||||||
|
- uses `name` given in metric configuration
|
||||||
|
**Note:** there are no doubles in metrics names supported by Prometheus. If so the exception occurs ant the application will be stopped.
|
||||||
|
|
||||||
|
### 🚀 Launching the application
|
||||||
|
Use provided `install.sh` script to prepare application to use as service. Or use following shell commands to initialize the Python's Virtual env.
|
||||||
|
```shell
|
||||||
|
python3 -m venv .venv
|
||||||
|
. ./.venv/bin/activate
|
||||||
|
pip install -r requirements.txt
|
||||||
|
deactivate
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Regular application<a id='StartRegular' />
|
||||||
|
In application directory:
|
||||||
|
```shell
|
||||||
|
. ./.venv/bin/activate
|
||||||
|
python ./main.py
|
||||||
|
```
|
||||||
|
|
||||||
|
##### System service (preferred option)<a id='StartService' />
|
||||||
|
Prepare the [dasExporter.service](dasExporter.service) file. Then launch commands:
|
||||||
|
```shell
|
||||||
|
sudo ln -s "$( cd -- $(dirname $0) >/dev/null 2>&1 ; pwd -P )/dasExporter.service" /etc/systemd/system/dasExporter.service
|
||||||
|
sudo systemctl daemon-reload
|
||||||
|
sudo systemctl start dasExporter
|
||||||
|
sudo systemctl enable dasExporter
|
||||||
|
```
|
||||||
|
To view service status use `sudo systemctl status dasExporter`
|
||||||
|
To restart the service use `sudo systemctl restart dasExporter`
|
||||||
|
To stop the service use `sudo systemctl stop dasExporter`
|
||||||
|
|
||||||
|
##### Docker application<a id='StartDocker' />
|
||||||
|
Use provided [docker-compose.yaml](docker-compose.yaml) and [Dockerfile](Dockerfile) files to launch Exporter in docker container.
|
||||||
|
|
||||||
|
**_Make sure you provided all mounts you need to be monitored in `volume` section in the `docker-compose.yaml` file and made according changes in [Disc Metrics Configuration](#DiscMetrics)._**
|
||||||
|
|
||||||
|
**Note:** In Docker some functions may be unavailable.
|
||||||
|
|
||||||
|
###### _Made by -=:dAs:=-_
|
||||||
21
app_config.py
Executable file
21
app_config.py
Executable file
@ -0,0 +1,21 @@
|
|||||||
|
import os
|
||||||
|
|
||||||
|
SCRIPT_PATH = os.path.dirname(__file__)
|
||||||
|
CONFIGS_DIR = SCRIPT_PATH + "/configs"
|
||||||
|
CONFIG_FILE_NAME = CONFIGS_DIR + "/config.json"
|
||||||
|
CONFIG_METRICS_FILE_NAME = CONFIGS_DIR + ("/metrics.json" if os.name.upper() == "POSIX" else "/metrics_win.json") # for debug purpose only
|
||||||
|
STOP_SERVER_FILE_NAME = SCRIPT_PATH + "/stop"
|
||||||
|
RESPONSE_PATH_SEPARATOR = '|'
|
||||||
|
CONFIG_METRICS_FILE_TIMESTAMP = 0.0
|
||||||
|
|
||||||
|
INSTANCE_PREFIX = ''
|
||||||
|
SERVER_PORT = 15200
|
||||||
|
SLEEP_THREAD_SECONDS = 30
|
||||||
|
UPTIME_UPDATE_SECONDS = 60
|
||||||
|
SYSTEM_UPDATE_SECONDS = 20
|
||||||
|
|
||||||
|
IS_DEBUG = False
|
||||||
|
IS_PRINT_INFO = False
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
pass
|
||||||
50
config_file.py
Executable file
50
config_file.py
Executable file
@ -0,0 +1,50 @@
|
|||||||
|
import json
|
||||||
|
import os
|
||||||
|
import yaml
|
||||||
|
|
||||||
|
def read_config(name):
|
||||||
|
if not os.path.isfile(name):
|
||||||
|
raise Exception(f"File {name} doesn't exists")
|
||||||
|
filename, ext = os.path.splitext(name)
|
||||||
|
if 'json' in ext:
|
||||||
|
return read_json(name), os.path.getmtime(name)
|
||||||
|
elif 'properties' in ext:
|
||||||
|
return read_prop(name), os.path.getmtime(name)
|
||||||
|
elif 'yaml' in ext or 'yml' in ext:
|
||||||
|
return read_yaml(name), os.path.getmtime(name)
|
||||||
|
else:
|
||||||
|
raise Exception("Wrong file type")
|
||||||
|
|
||||||
|
def read_json(name):
|
||||||
|
with open(name, 'r') as f:
|
||||||
|
j_conf = json.load(f)
|
||||||
|
conf = {}
|
||||||
|
for key, value in j_conf.items():
|
||||||
|
conf[key] = value
|
||||||
|
return conf
|
||||||
|
|
||||||
|
def read_prop(filepath, sep='=', comment_char='#'):
|
||||||
|
conf = {}
|
||||||
|
with open(filepath, "rt") as f:
|
||||||
|
for line in f:
|
||||||
|
l = line.strip()
|
||||||
|
if l and not l.startswith(comment_char):
|
||||||
|
key_value = l.split(sep)
|
||||||
|
key = key_value[0].strip()
|
||||||
|
value = sep.join(key_value[1:]).strip().strip('"')
|
||||||
|
conf[key] = value
|
||||||
|
return conf
|
||||||
|
|
||||||
|
def read_yaml(name): #ToDo: need to be tested!
|
||||||
|
conf = {}
|
||||||
|
with open(name, 'r') as f:
|
||||||
|
y_conf = yaml.safe_load(f)
|
||||||
|
for key, value in y_conf.items():
|
||||||
|
conf[key] = value
|
||||||
|
return conf
|
||||||
|
|
||||||
|
def main():
|
||||||
|
pass
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
13
configs/config_default.json
Executable file
13
configs/config_default.json
Executable file
@ -0,0 +1,13 @@
|
|||||||
|
{
|
||||||
|
"monitor": {
|
||||||
|
"config": {
|
||||||
|
"debug": "false",
|
||||||
|
"print_info": "false",
|
||||||
|
"interval_seconds": 30,
|
||||||
|
"uptime_update_seconds": 60,
|
||||||
|
"port": 15200,
|
||||||
|
"stop_file_name": "/stop",
|
||||||
|
"response_path_separator": "|"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
13
configs/metrics_default.json
Executable file
13
configs/metrics_default.json
Executable file
@ -0,0 +1,13 @@
|
|||||||
|
{
|
||||||
|
"monitor": {
|
||||||
|
"instance_prefix": "",
|
||||||
|
"metrics": {
|
||||||
|
"disk": [],
|
||||||
|
"health": [],
|
||||||
|
"ping": [],
|
||||||
|
"iface": [],
|
||||||
|
"rest_value": [],
|
||||||
|
"shell_value": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
14
dasExporter.service
Normal file
14
dasExporter.service
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
[Unit]
|
||||||
|
Description = Das Simple Exporter for Prometheus
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
User = das
|
||||||
|
Group = das
|
||||||
|
WorkingDirectory = /path/to/DasExporter
|
||||||
|
ExecStart = /path/to/DasExporter/start.sh
|
||||||
|
Restart = always
|
||||||
|
RestartSec = 5
|
||||||
|
SyslogIdentifier = DasExporter
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy = multi-user.target
|
||||||
19
docker-compose.yaml
Executable file
19
docker-compose.yaml
Executable file
@ -0,0 +1,19 @@
|
|||||||
|
services:
|
||||||
|
das_exporter:
|
||||||
|
build: .
|
||||||
|
container_name: "DasExporter"
|
||||||
|
restart: "unless-stopped"
|
||||||
|
# networks:
|
||||||
|
# - internal
|
||||||
|
user: "1000"
|
||||||
|
ports:
|
||||||
|
- 9010:15200
|
||||||
|
volumes:
|
||||||
|
- ./data/config:/usr/src/app/configs
|
||||||
|
- /:/usr/src/app/FS/root:ro
|
||||||
|
- /home:/usr/src/app/FS/home:ro
|
||||||
|
|
||||||
|
#networks:
|
||||||
|
# internal:
|
||||||
|
# name: internal
|
||||||
|
# external: true
|
||||||
17
install.sh
Normal file
17
install.sh
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
python3 -m venv .venv
|
||||||
|
|
||||||
|
. ./.venv/bin/activate
|
||||||
|
|
||||||
|
pip install -r requirements.txt
|
||||||
|
|
||||||
|
deactivate
|
||||||
|
|
||||||
|
SCRIPT_PATH=$( cd -- $(dirname $0) >/dev/null 2>&1 ; pwd -P )
|
||||||
|
|
||||||
|
sudo ln -s "${SCRIPT_PATH}/dasExporter.service" /etc/systemd/system/dasExporter.service
|
||||||
|
|
||||||
|
sudo systemctl daemon-reload
|
||||||
|
sudo systemctl start dasExporter
|
||||||
|
sudo systemctl enable dasExporter
|
||||||
114
main.py
Executable file
114
main.py
Executable file
@ -0,0 +1,114 @@
|
|||||||
|
#!/usr/bin/python3
|
||||||
|
# Prometheus Metrics by -=:dAs:=-
|
||||||
|
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
import time
|
||||||
|
|
||||||
|
import metrics.MetricClasses as M
|
||||||
|
import app_config
|
||||||
|
|
||||||
|
from config_file import read_config as read_cfg
|
||||||
|
from prometheus_client import start_http_server
|
||||||
|
|
||||||
|
def read_app_config():
|
||||||
|
j, _ = read_cfg(app_config.CONFIG_FILE_NAME)
|
||||||
|
config = j['monitor']['config']
|
||||||
|
return config
|
||||||
|
|
||||||
|
def read_metrics_config():
|
||||||
|
j, app_config.CONFIG_METRICS_FILE_TIMESTAMP = read_cfg(app_config.CONFIG_METRICS_FILE_NAME)
|
||||||
|
metrics = j['monitor']['metrics']
|
||||||
|
if 'instance_prefix' in j['monitor']:
|
||||||
|
prefix = j['monitor']['instance_prefix']
|
||||||
|
else:
|
||||||
|
prefix = ''
|
||||||
|
return metrics, prefix
|
||||||
|
|
||||||
|
def is_need_to_stop():
|
||||||
|
return os.path.isfile(app_config.STOP_SERVER_FILE_NAME)
|
||||||
|
|
||||||
|
def get_config_value(cfg, name, default):
|
||||||
|
return cfg[name] if name in cfg else default
|
||||||
|
|
||||||
|
def parse_config(cfg):
|
||||||
|
app_config.IS_DEBUG = get_config_value(cfg, 'debug', app_config.IS_DEBUG).lower() == 'true'
|
||||||
|
app_config.IS_PRINT_INFO = get_config_value(cfg, 'print_info', app_config.IS_PRINT_INFO).lower() == 'true'
|
||||||
|
app_config.SLEEP_THREAD_SECONDS = get_config_value(cfg, 'interval_seconds', app_config.SLEEP_THREAD_SECONDS)
|
||||||
|
app_config.SERVER_PORT = get_config_value(cfg, 'port', app_config.SERVER_PORT)
|
||||||
|
app_config.UPTIME_UPDATE_SECONDS = get_config_value(cfg, 'uptime_update_seconds', app_config.UPTIME_UPDATE_SECONDS)
|
||||||
|
app_config.SYSTEM_UPDATE_SECONDS = get_config_value(cfg, 'system_update_seconds', app_config.SYSTEM_UPDATE_SECONDS)
|
||||||
|
app_config.RESPONSE_PATH_SEPARATOR = get_config_value(cfg, 'response_path_separator', app_config.RESPONSE_PATH_SEPARATOR)
|
||||||
|
file_name = get_config_value(cfg, 'stop_file_name', app_config.STOP_SERVER_FILE_NAME)
|
||||||
|
app_config.STOP_SERVER_FILE_NAME = app_config.SCRIPT_PATH + (file_name if file_name.startswith('/') else '/' + file_name)
|
||||||
|
|
||||||
|
def init_metric_entities(data):
|
||||||
|
return {
|
||||||
|
M.DiskMetric(data, app_config.INSTANCE_PREFIX),
|
||||||
|
M.HealthMetric(data, app_config.INSTANCE_PREFIX),
|
||||||
|
M.IcmpMetric(data, app_config.INSTANCE_PREFIX),
|
||||||
|
M.InterfaceMetric(data, app_config.INSTANCE_PREFIX),
|
||||||
|
M.RestValueMetric(data, app_config.INSTANCE_PREFIX),
|
||||||
|
M.ShellValueMetric(data, app_config.INSTANCE_PREFIX),
|
||||||
|
M.UptimeMetric(app_config.UPTIME_UPDATE_SECONDS),
|
||||||
|
M.SystemMetric(app_config.SYSTEM_UPDATE_SECONDS)
|
||||||
|
}
|
||||||
|
|
||||||
|
def is_need_to_reload_config():
|
||||||
|
return app_config.CONFIG_METRICS_FILE_TIMESTAMP != os.path.getmtime(app_config.CONFIG_METRICS_FILE_NAME)
|
||||||
|
|
||||||
|
def print_config_info_debug():
|
||||||
|
print('-=: Debug Mode :=-')
|
||||||
|
print(f'\tSCRIPT_PATH={app_config.SCRIPT_PATH}')
|
||||||
|
print(f'\tCONFIGS_DIR={app_config.CONFIGS_DIR}')
|
||||||
|
print(f'\tCONFIG_FILE_NAME={app_config.CONFIG_FILE_NAME}')
|
||||||
|
print(f'\tCONFIG_METRICS_FILE_NAME={app_config.CONFIG_METRICS_FILE_NAME}')
|
||||||
|
print(f'\tSTOP_SERVER_FILE_NAME={app_config.STOP_SERVER_FILE_NAME}')
|
||||||
|
print(f'\tRESPONSE_PATH_SEPARATOR={app_config.RESPONSE_PATH_SEPARATOR}')
|
||||||
|
print(f'\t---')
|
||||||
|
print(f'\tSERVER_PORT={app_config.SERVER_PORT}')
|
||||||
|
print(f'\tSLEEP_THREAD_SECONDS={app_config.SLEEP_THREAD_SECONDS}')
|
||||||
|
print(f'\tUPTIME_UPDATE_SECONDS={app_config.UPTIME_UPDATE_SECONDS}')
|
||||||
|
print(f'\tSYSTEM_UPDATE_SECONDS={app_config.SYSTEM_UPDATE_SECONDS}')
|
||||||
|
print(f'\t---')
|
||||||
|
print(f'\tIS_PRINT_INFO={app_config.IS_PRINT_INFO}')
|
||||||
|
|
||||||
|
def main():
|
||||||
|
print("-=: Collector started :=-")
|
||||||
|
if os.path.isfile(app_config.CONFIG_FILE_NAME):
|
||||||
|
config = read_app_config()
|
||||||
|
parse_config(config)
|
||||||
|
if app_config.IS_DEBUG:
|
||||||
|
print_config_info_debug()
|
||||||
|
|
||||||
|
metrics_config, app_config.INSTANCE_PREFIX = read_metrics_config()
|
||||||
|
metric_objects = init_metric_entities(metrics_config)
|
||||||
|
|
||||||
|
start_http_server(app_config.SERVER_PORT)
|
||||||
|
|
||||||
|
while True:
|
||||||
|
if is_need_to_stop():
|
||||||
|
os.remove(app_config.STOP_SERVER_FILE_NAME)
|
||||||
|
print("-=: Collector stopped :=-")
|
||||||
|
sys.exit(0)
|
||||||
|
|
||||||
|
if is_need_to_reload_config():
|
||||||
|
print('-=: Reloading metrics configuration :=-')
|
||||||
|
metrics_config, app_config.INSTANCE_PREFIX = read_metrics_config()
|
||||||
|
metric_objects = init_metric_entities(metrics_config)
|
||||||
|
print('-=: Metrics configuration reloaded :=-')
|
||||||
|
|
||||||
|
for m in metric_objects:
|
||||||
|
m.proceed_metric()
|
||||||
|
if app_config.IS_DEBUG:
|
||||||
|
m.print_debug_info()
|
||||||
|
|
||||||
|
if app_config.IS_DEBUG:
|
||||||
|
print('- - -')
|
||||||
|
|
||||||
|
time.sleep(app_config.SLEEP_THREAD_SECONDS)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
|
|
||||||
292
metrics/DataStructures.py
Executable file
292
metrics/DataStructures.py
Executable file
@ -0,0 +1,292 @@
|
|||||||
|
import time
|
||||||
|
from threading import Thread
|
||||||
|
|
||||||
|
import psutil
|
||||||
|
from prometheus_client import Gauge, Enum, Counter, REGISTRY
|
||||||
|
|
||||||
|
import app_config
|
||||||
|
|
||||||
|
ENUM_UP_DN_STATES = ['up', 'dn']
|
||||||
|
|
||||||
|
def get_metric(name):
|
||||||
|
return REGISTRY._names_to_collectors.get(name)
|
||||||
|
|
||||||
|
def get_gauge_metric(metric_name, descr):
|
||||||
|
metric = get_metric(metric_name)
|
||||||
|
if metric is None:
|
||||||
|
metric = Gauge(metric_name, descr)
|
||||||
|
return metric
|
||||||
|
|
||||||
|
def get_counter_metric(metric_name, descr):
|
||||||
|
metric = get_metric(metric_name)
|
||||||
|
if metric is None:
|
||||||
|
metric = Counter(metric_name, descr)
|
||||||
|
return metric
|
||||||
|
|
||||||
|
def get_enum_metric(metric_name, descr, states):
|
||||||
|
metric = get_metric(metric_name)
|
||||||
|
if metric is None:
|
||||||
|
metric = Enum(metric_name, descr, states=states)
|
||||||
|
return metric
|
||||||
|
|
||||||
|
|
||||||
|
class AbstractData:
|
||||||
|
METRIC_NAME_PREFIX = 'das_'
|
||||||
|
def __init__(self, name, interval, prefix=''):
|
||||||
|
self.name = name
|
||||||
|
self.interval = interval
|
||||||
|
self.instance_prefix = prefix
|
||||||
|
self.updated_at = int(time.time())
|
||||||
|
|
||||||
|
def set_update_time(self):
|
||||||
|
self.updated_at = int(time.time())
|
||||||
|
|
||||||
|
def is_need_to_update(self):
|
||||||
|
return self.updated_at + self.interval <= int(time.time())
|
||||||
|
|
||||||
|
def get_metric_name(self, metric_text, name):
|
||||||
|
return (self.METRIC_NAME_PREFIX +
|
||||||
|
metric_text + '_' +
|
||||||
|
(self.instance_prefix + '_' if self.instance_prefix else '') +
|
||||||
|
name)
|
||||||
|
|
||||||
|
def print_trigger_info(self):
|
||||||
|
if app_config.IS_PRINT_INFO:
|
||||||
|
print(f'{time.strftime("%Y-%m-%d %H:%M:%S", time.localtime())} [INFO]: Touch "{self.name}"')
|
||||||
|
|
||||||
|
|
||||||
|
class DiskData(AbstractData):
|
||||||
|
g_total: Gauge
|
||||||
|
g_used: Gauge
|
||||||
|
g_free: Gauge
|
||||||
|
def __init__(self, mount_point='/', total=0, used=0, free=0, interval=60, name='', prefix=''):
|
||||||
|
super().__init__(name, interval, prefix)
|
||||||
|
self.mount_point = mount_point
|
||||||
|
self.total = total
|
||||||
|
self.used = used
|
||||||
|
self.free = free
|
||||||
|
self.g_total = get_gauge_metric(self.get_metric_name('disk_total_bytes', name), 'Total bytes on disk')
|
||||||
|
self.g_used = get_gauge_metric(self.get_metric_name('disk_used_bytes', name), 'Used bytes on disk')
|
||||||
|
self.g_free = get_gauge_metric(self.get_metric_name('disk_free_bytes', name), 'Free bytes on disk')
|
||||||
|
self.set_data(total, used, free)
|
||||||
|
|
||||||
|
def set_data(self, total, used, free):
|
||||||
|
self.g_total.set(total)
|
||||||
|
self.g_used.set(used)
|
||||||
|
self.g_free.set(free)
|
||||||
|
self.set_update_time()
|
||||||
|
self.print_trigger_info()
|
||||||
|
|
||||||
|
|
||||||
|
class HealthData(AbstractData):
|
||||||
|
e_state: Enum
|
||||||
|
def __init__(self, name, url, interval, timeout, is_up=False, method='GET', user=None, password=None, headers=None, prefix=''):
|
||||||
|
super().__init__(name, interval, prefix)
|
||||||
|
if headers is None:
|
||||||
|
headers = {}
|
||||||
|
self.url = url
|
||||||
|
self.timeout = timeout
|
||||||
|
self.is_up = is_up
|
||||||
|
self.method = method.upper()
|
||||||
|
self.user = user
|
||||||
|
self.password = password
|
||||||
|
self.headers = headers
|
||||||
|
metric_name = self.get_metric_name('service_health', name)
|
||||||
|
self.e_state = get_enum_metric(metric_name, 'Service health', ENUM_UP_DN_STATES)
|
||||||
|
self.set_status(is_up)
|
||||||
|
|
||||||
|
def set_status(self, is_up):
|
||||||
|
self.is_up = is_up
|
||||||
|
self.e_state.state(ENUM_UP_DN_STATES[0] if is_up else ENUM_UP_DN_STATES[1])
|
||||||
|
self.set_update_time()
|
||||||
|
self.print_trigger_info()
|
||||||
|
|
||||||
|
|
||||||
|
class RestValueData(AbstractData):
|
||||||
|
g_value: Gauge
|
||||||
|
def __init__(self, name, url, interval, timeout, value=None, method='GET', user=None, password=None, headers=None, prefix='',
|
||||||
|
result_type='single', result_path=''):
|
||||||
|
super().__init__(name, interval, prefix)
|
||||||
|
if headers is None:
|
||||||
|
headers = {}
|
||||||
|
self.url = url
|
||||||
|
self.timeout = timeout
|
||||||
|
self.method = method.upper()
|
||||||
|
self.user = user
|
||||||
|
self.password = password
|
||||||
|
self.headers = headers
|
||||||
|
self.value = value
|
||||||
|
self.type = result_type
|
||||||
|
self.path = result_path
|
||||||
|
metric_name = self.get_metric_name('rest_value', name)
|
||||||
|
self.g_value = get_gauge_metric(metric_name, 'Remote REST API Value ' + name)
|
||||||
|
self.set_value(value)
|
||||||
|
|
||||||
|
def set_value(self, value):
|
||||||
|
self.value = value
|
||||||
|
try:
|
||||||
|
self.g_value.set(int(value))
|
||||||
|
except:
|
||||||
|
self.g_value.set(0)
|
||||||
|
|
||||||
|
self.set_update_time()
|
||||||
|
self.print_trigger_info()
|
||||||
|
|
||||||
|
|
||||||
|
class ShellValueData(AbstractData):
|
||||||
|
g_value: Gauge
|
||||||
|
def __init__(self, name, interval, command, value=None, args=None, prefix=''):
|
||||||
|
super().__init__(name, interval, prefix)
|
||||||
|
if args is None:
|
||||||
|
args = {}
|
||||||
|
self.command = command
|
||||||
|
self.value = value
|
||||||
|
self.args = args
|
||||||
|
metric_name = self.get_metric_name('shell_value', name)
|
||||||
|
self.g_value = get_gauge_metric(metric_name, 'Shell Value ' + name)
|
||||||
|
self.set_value(value)
|
||||||
|
|
||||||
|
def set_value(self, value):
|
||||||
|
self.value = value
|
||||||
|
try:
|
||||||
|
self.g_value.set(int(value))
|
||||||
|
except:
|
||||||
|
self.g_value.set(0)
|
||||||
|
|
||||||
|
self.set_update_time()
|
||||||
|
self.print_trigger_info()
|
||||||
|
|
||||||
|
|
||||||
|
class IcmpData(AbstractData):
|
||||||
|
e_state: Enum
|
||||||
|
def __init__(self, name, ip, count, interval, is_up=False, prefix=''):
|
||||||
|
super().__init__(name, interval, prefix)
|
||||||
|
self.ip = ip
|
||||||
|
self.count = count
|
||||||
|
self.is_up = is_up
|
||||||
|
metric_name = self.get_metric_name('host_available', name)
|
||||||
|
self.e_state = get_enum_metric(metric_name, 'Host availability', ENUM_UP_DN_STATES)
|
||||||
|
self.set_status(is_up)
|
||||||
|
|
||||||
|
def set_status(self, is_up):
|
||||||
|
self.is_up = is_up
|
||||||
|
self.e_state.state(ENUM_UP_DN_STATES[0] if is_up else ENUM_UP_DN_STATES[1])
|
||||||
|
self.set_update_time()
|
||||||
|
self.print_trigger_info()
|
||||||
|
|
||||||
|
|
||||||
|
class InterfaceData(AbstractData):
|
||||||
|
g_sent: Counter
|
||||||
|
g_receive: Counter
|
||||||
|
def __init__(self, name, iface, interval, sent, receive, prefix=''):
|
||||||
|
super().__init__(name, interval, prefix)
|
||||||
|
self.iface = iface
|
||||||
|
self.sent = sent
|
||||||
|
self.receive = receive
|
||||||
|
sent_metric_name = self.get_metric_name('net_interface_sent_bytes', name)
|
||||||
|
self.g_sent = get_counter_metric(sent_metric_name, 'Network Interface bytes sent')
|
||||||
|
receive_metric_name = self.get_metric_name('net_interface_receive_bytes', name)
|
||||||
|
self.g_receive = get_counter_metric(receive_metric_name, 'Network Interface bytes receive')
|
||||||
|
self.set_data(sent, receive)
|
||||||
|
|
||||||
|
def set_data(self, sent, receive):
|
||||||
|
sent_delta = sent - self.sent
|
||||||
|
recv_delta = receive - self.receive
|
||||||
|
self.sent = sent
|
||||||
|
self.receive = receive
|
||||||
|
self.g_sent.inc(sent_delta)
|
||||||
|
self.g_receive.inc(recv_delta)
|
||||||
|
self.set_update_time()
|
||||||
|
self.print_trigger_info()
|
||||||
|
|
||||||
|
|
||||||
|
class UptimeData(AbstractData):
|
||||||
|
START_TIME = int(time.time())
|
||||||
|
c_uptime: Counter
|
||||||
|
def __init__(self, interval, prefix=''):
|
||||||
|
super().__init__('uptime', interval, prefix)
|
||||||
|
self.uptime = 0
|
||||||
|
metric_name = self.get_metric_name('exporter', self.name)
|
||||||
|
self.c_uptime = get_counter_metric(metric_name, 'Exporter Uptime in seconds')
|
||||||
|
self.set_data()
|
||||||
|
|
||||||
|
def set_data(self):
|
||||||
|
uptime = int(time.time()) - self.START_TIME
|
||||||
|
self.c_uptime.inc(uptime - self.uptime)
|
||||||
|
self.uptime = uptime
|
||||||
|
self.set_update_time()
|
||||||
|
self.print_trigger_info()
|
||||||
|
|
||||||
|
|
||||||
|
class SystemData(AbstractData):
|
||||||
|
BOOT_TIME = int(psutil.boot_time())
|
||||||
|
c_uptime: Counter
|
||||||
|
g_cpu: Gauge
|
||||||
|
g_memory: Gauge
|
||||||
|
g_chassis_temp: Gauge
|
||||||
|
g_cpu_temp: Gauge
|
||||||
|
def __init__(self, interval, prefix=''):
|
||||||
|
super().__init__('system', interval, prefix)
|
||||||
|
self.cpu, self.memory, self.uptime, self.ch_temp, self.cpu_temp = 0,0,0,0,0
|
||||||
|
self.init_metrics()
|
||||||
|
self.set_data()
|
||||||
|
|
||||||
|
def init_metrics(self):
|
||||||
|
uptime_metric_name = self.get_metric_name(self.name, 'uptime_seconds')
|
||||||
|
self.c_uptime = get_counter_metric(uptime_metric_name, 'System uptime')
|
||||||
|
cpu_metric_name = self.get_metric_name(self.name, 'cpu_percent')
|
||||||
|
self.g_cpu = get_gauge_metric(cpu_metric_name, 'CPU used percent')
|
||||||
|
mem_metric_name = self.get_metric_name(self.name, 'memory_percent')
|
||||||
|
self.g_memory = get_gauge_metric(mem_metric_name, 'Memory used percent')
|
||||||
|
chassis_temp_metric_name = self.get_metric_name(self.name, 'ChassisTemperature_current')
|
||||||
|
self.g_chassis_temp = get_gauge_metric(chassis_temp_metric_name, 'Current Chassis Temperature overall')
|
||||||
|
cpu_temp_metric_name = self.get_metric_name(self.name, 'CpuTemperature_current')
|
||||||
|
self.g_cpu_temp = get_gauge_metric(cpu_temp_metric_name, 'Current CPU Temperature overall')
|
||||||
|
|
||||||
|
def set_data(self):
|
||||||
|
uptime = int(time.time()) - self.BOOT_TIME
|
||||||
|
self.c_uptime.inc(uptime - self.uptime)
|
||||||
|
self.uptime = uptime
|
||||||
|
self.memory = psutil.virtual_memory().percent
|
||||||
|
self.g_memory.set(self.memory)
|
||||||
|
Thread(target=self.set_cpu_percent()).run()
|
||||||
|
|
||||||
|
try:
|
||||||
|
avg_temp = 0
|
||||||
|
temps = psutil.sensors_temperatures()
|
||||||
|
if 'coretemp' in temps:
|
||||||
|
self.cpu_temp = temps["coretemp"][0].current
|
||||||
|
elif 'cpu_thermal' in temps:
|
||||||
|
self.cpu_temp = temps["cpu_thermal"][0].current
|
||||||
|
else:
|
||||||
|
# if no coretemp we try to get an average temperature
|
||||||
|
temp, amount = 0, 0
|
||||||
|
for i in temps.keys():
|
||||||
|
if i != 'acpitz':
|
||||||
|
temp += temps.get(i)[0].current
|
||||||
|
amount += 1
|
||||||
|
self.cpu_temp = temp // amount
|
||||||
|
|
||||||
|
if 'acpitz' in temps:
|
||||||
|
self.ch_temp = temps["acpitz"][0].current
|
||||||
|
else:
|
||||||
|
self.ch_temp = self.cpu_temp
|
||||||
|
|
||||||
|
self.g_chassis_temp.set(self.ch_temp)
|
||||||
|
self.g_cpu_temp.set(self.cpu_temp)
|
||||||
|
except:
|
||||||
|
self.ch_temp = -500
|
||||||
|
self.cpu_temp = -500
|
||||||
|
self.g_chassis_temp.set(self.ch_temp)
|
||||||
|
self.g_cpu_temp.set(self.cpu_temp)
|
||||||
|
|
||||||
|
self.set_update_time()
|
||||||
|
self.print_trigger_info()
|
||||||
|
|
||||||
|
def set_cpu_percent(self):
|
||||||
|
self.cpu = psutil.cpu_percent(1)
|
||||||
|
self.g_cpu.set(self.cpu)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
pass
|
||||||
300
metrics/MetricClasses.py
Executable file
300
metrics/MetricClasses.py
Executable file
@ -0,0 +1,300 @@
|
|||||||
|
import json
|
||||||
|
import shutil
|
||||||
|
from abc import abstractmethod
|
||||||
|
import time
|
||||||
|
import platform
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
import requests
|
||||||
|
import psutil
|
||||||
|
|
||||||
|
import app_config
|
||||||
|
|
||||||
|
from threading import Thread
|
||||||
|
from metrics.DataStructures import DiskData, HealthData, IcmpData, ENUM_UP_DN_STATES, InterfaceData, UptimeData, \
|
||||||
|
SystemData, RestValueData, ShellValueData
|
||||||
|
|
||||||
|
class AbstractMetric:
|
||||||
|
metric_key = ""
|
||||||
|
config = {}
|
||||||
|
def __init__(self, key, config):
|
||||||
|
self.metric_key = key
|
||||||
|
if key and key in config:
|
||||||
|
self.config = config[key]
|
||||||
|
self.data_array = []
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def proceed_metric(self):
|
||||||
|
pass
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def print_debug_info(self):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def is_health_check(url, timeout, method, user, pwd, headers, callback=None):
|
||||||
|
session = requests.Session()
|
||||||
|
if user and pwd:
|
||||||
|
session.auth = (user, pwd)
|
||||||
|
try:
|
||||||
|
response = session.request(
|
||||||
|
url=url,
|
||||||
|
timeout=timeout,
|
||||||
|
method=method,
|
||||||
|
headers=headers
|
||||||
|
)
|
||||||
|
result = response.status_code == 200
|
||||||
|
if callback is not None:
|
||||||
|
callback(result)
|
||||||
|
else:
|
||||||
|
return result
|
||||||
|
except (requests.ConnectTimeout, requests.exceptions.ConnectionError) as e:
|
||||||
|
return False
|
||||||
|
|
||||||
|
def get_rest_value(url, timeout, method, user, pwd, headers, callback=None, result_type='single', path=''):
|
||||||
|
session = requests.Session()
|
||||||
|
if user and pwd:
|
||||||
|
session.auth = (user, pwd)
|
||||||
|
try:
|
||||||
|
response = session.request(
|
||||||
|
url=url,
|
||||||
|
timeout=timeout,
|
||||||
|
method=method,
|
||||||
|
headers=headers
|
||||||
|
)
|
||||||
|
resp = json.loads(response.content.decode().replace("'", '"'))
|
||||||
|
result = parse_response(resp, path)
|
||||||
|
if not result.isalnum():
|
||||||
|
result = 0
|
||||||
|
if callback is not None:
|
||||||
|
callback(result)
|
||||||
|
else:
|
||||||
|
return result
|
||||||
|
except (requests.ConnectTimeout, requests.exceptions.ConnectionError) as e:
|
||||||
|
return 0
|
||||||
|
|
||||||
|
def parse_response(resp, path):
|
||||||
|
if app_config.RESPONSE_PATH_SEPARATOR in path:
|
||||||
|
r = None
|
||||||
|
for s in path.split(app_config.RESPONSE_PATH_SEPARATOR):
|
||||||
|
if r is None:
|
||||||
|
if s in resp:
|
||||||
|
r = resp[s]
|
||||||
|
else:
|
||||||
|
return ''
|
||||||
|
else:
|
||||||
|
if s in r:
|
||||||
|
r = r[s]
|
||||||
|
else:
|
||||||
|
return ''
|
||||||
|
return r
|
||||||
|
else:
|
||||||
|
if path in resp:
|
||||||
|
return resp[path]
|
||||||
|
else:
|
||||||
|
return ''
|
||||||
|
|
||||||
|
def get_shell_value(command, args, callback=None):
|
||||||
|
cmd = [command, ' '.join(str(s) for s in args)]
|
||||||
|
try:
|
||||||
|
output = subprocess.check_output(cmd)
|
||||||
|
if output.isalnum():
|
||||||
|
result = int(output)
|
||||||
|
else:
|
||||||
|
result = 0
|
||||||
|
except:
|
||||||
|
result = 0
|
||||||
|
|
||||||
|
if callback is not None:
|
||||||
|
callback(result)
|
||||||
|
else:
|
||||||
|
return result
|
||||||
|
|
||||||
|
def is_ping(ip, count, callback=None):
|
||||||
|
param = '-n' if platform.system().lower() == 'windows' else '-c'
|
||||||
|
command = ['ping', param, str(count), ip]
|
||||||
|
output = subprocess.check_output(command)
|
||||||
|
result = 'unreachable' not in str(output) and 'could not find' not in str(output) and 'time out' not in str(output)
|
||||||
|
if callback is not None:
|
||||||
|
callback(result)
|
||||||
|
else:
|
||||||
|
return result
|
||||||
|
|
||||||
|
def get_net_iface_stat(name):
|
||||||
|
return psutil.net_io_counters(pernic=True).get(name)
|
||||||
|
|
||||||
|
def get_next_update_time(d):
|
||||||
|
return time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(d.updated_at + d.interval))
|
||||||
|
|
||||||
|
|
||||||
|
class DiskMetric(AbstractMetric):
|
||||||
|
def __init__(self, config, prefix=''):
|
||||||
|
super().__init__('disk', config)
|
||||||
|
for d in self.config:
|
||||||
|
mount_point, interval, name = d['path'], d['interval'], d['name']
|
||||||
|
total, used, free = shutil.disk_usage(mount_point)
|
||||||
|
self.data_array.append(DiskData(mount_point, total, used, free, interval, name, prefix))
|
||||||
|
|
||||||
|
def proceed_metric(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
if d.is_need_to_update():
|
||||||
|
mount_point = d.mount_point
|
||||||
|
d.total, d.used, d.free = shutil.disk_usage(mount_point)
|
||||||
|
d.set_data(d.total, d.used, d.free)
|
||||||
|
|
||||||
|
def print_debug_info(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
print(f'[DEBUG] (next update at {get_next_update_time(d)}) {d.mount_point}: total={d.total // (2 ** 30)} Gb, used={d.used // (2 ** 30)} Gb, free={d.free // (2 ** 30)} Gb')
|
||||||
|
|
||||||
|
|
||||||
|
class HealthMetric(AbstractMetric):
|
||||||
|
def __init__(self, config, prefix=''):
|
||||||
|
super().__init__('health', config)
|
||||||
|
for d in self.config:
|
||||||
|
name, url, interval, timeout, method = d['name'], d['url'], d['interval'], d['timeout'], d['method']
|
||||||
|
if 'auth' in self.config:
|
||||||
|
user = d['auth']['user']
|
||||||
|
pwd = d['auth']['pass']
|
||||||
|
else:
|
||||||
|
user = ''
|
||||||
|
pwd = ''
|
||||||
|
if 'headers' in self.config:
|
||||||
|
headers = d['headers']
|
||||||
|
else:
|
||||||
|
headers = ''
|
||||||
|
result = is_health_check(url, timeout, method, user, pwd, headers)
|
||||||
|
self.data_array.append(HealthData(name, url, interval, timeout, result, method, user, pwd, headers, prefix))
|
||||||
|
|
||||||
|
def proceed_metric(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
if d.is_need_to_update():
|
||||||
|
thread = Thread(target=is_health_check, args=(d.url, d.timeout, d.method, d.user, d.password, d.headers, d.set_status))
|
||||||
|
thread.start()
|
||||||
|
|
||||||
|
def print_debug_info(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
print(f'[DEBUG] (next update at {get_next_update_time(d)}) {d.url}: {ENUM_UP_DN_STATES[0].upper() if d.is_up else ENUM_UP_DN_STATES[1].upper()}')
|
||||||
|
|
||||||
|
|
||||||
|
class IcmpMetric(AbstractMetric):
|
||||||
|
def __init__(self, config, prefix=''):
|
||||||
|
super().__init__('ping', config)
|
||||||
|
for d in self.config:
|
||||||
|
name, ip, count, interval = d['name'], d['ip'], d['count'], d['interval']
|
||||||
|
result = is_ping(ip, count)
|
||||||
|
self.data_array.append(IcmpData(name, ip, count, interval, result, prefix))
|
||||||
|
|
||||||
|
def proceed_metric(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
if d.is_need_to_update():
|
||||||
|
thread = Thread(target=is_ping, args=(d.ip, d.count, d.set_status))
|
||||||
|
thread.start()
|
||||||
|
|
||||||
|
def print_debug_info(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
print(f'[DEBUG] (next update at {get_next_update_time(d)}) {d.ip}: {"UP" if d.is_up else "DN"}')
|
||||||
|
|
||||||
|
|
||||||
|
class InterfaceMetric(AbstractMetric):
|
||||||
|
def __init__(self, config, prefix=''):
|
||||||
|
super().__init__('iface', config)
|
||||||
|
for d in self.config:
|
||||||
|
name, iface, interval = d['name'], d['iface'], d['interval']
|
||||||
|
result = get_net_iface_stat(iface)
|
||||||
|
self.data_array.append(InterfaceData(name, iface, interval, result.bytes_sent, result.bytes_recv, prefix))
|
||||||
|
|
||||||
|
def proceed_metric(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
if d.is_need_to_update():
|
||||||
|
result = get_net_iface_stat(d.iface)
|
||||||
|
d.set_data(result.bytes_sent, result.bytes_recv)
|
||||||
|
|
||||||
|
def print_debug_info(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
print(f'[DEBUG] (next update at {get_next_update_time(d)}) {d.iface}: sent={d.sent}, receive={d.receive}')
|
||||||
|
|
||||||
|
|
||||||
|
class RestValueMetric(AbstractMetric):
|
||||||
|
def __init__(self, config, prefix=''):
|
||||||
|
super().__init__('rest_value', config)
|
||||||
|
for d in self.config:
|
||||||
|
name, url, interval, timeout, method = d['name'], d['url'], d['interval'], d['timeout'], d['method']
|
||||||
|
if 'auth' in self.config:
|
||||||
|
user = d['auth']['user']
|
||||||
|
pwd = d['auth']['pass']
|
||||||
|
else:
|
||||||
|
user = ''
|
||||||
|
pwd = ''
|
||||||
|
if 'headers' in self.config:
|
||||||
|
headers = d['headers']
|
||||||
|
else:
|
||||||
|
headers = ''
|
||||||
|
result_type, result_path = d['result_type'], d['result_path']
|
||||||
|
result = get_rest_value(url=url, timeout=timeout, method=method, user=user, pwd=pwd, headers=headers,
|
||||||
|
result_type=result_type, path=result_path)
|
||||||
|
self.data_array.append(RestValueData(name, url, interval, timeout, result, method, user, pwd, headers, prefix, result_type, result_path))
|
||||||
|
|
||||||
|
def proceed_metric(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
if d.is_need_to_update():
|
||||||
|
thread = Thread(target=get_rest_value, args=(d.url, d.timeout, d.method, d.user, d.password, d.headers,
|
||||||
|
d.set_value, d.type, d.path))
|
||||||
|
thread.start()
|
||||||
|
|
||||||
|
def print_debug_info(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
print(f'[DEBUG] (next update at {get_next_update_time(d)}) on {d.url}: by {d.method} in {d.path} got value="{d.value}"')
|
||||||
|
|
||||||
|
|
||||||
|
class ShellValueMetric(AbstractMetric):
|
||||||
|
def __init__(self, config, prefix=''):
|
||||||
|
super().__init__('shell_value', config)
|
||||||
|
for d in self.config:
|
||||||
|
name, command, interval, args = d['name'], d['command'], d['interval'], d['args']
|
||||||
|
result = get_shell_value(command, args)
|
||||||
|
self.data_array.append(ShellValueData(name, interval, command, result, args, prefix))
|
||||||
|
|
||||||
|
def proceed_metric(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
if d.is_need_to_update():
|
||||||
|
thread = Thread(target=get_shell_value, args=(d.command, d.args, d.set_value))
|
||||||
|
thread.start()
|
||||||
|
|
||||||
|
def print_debug_info(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
print(f'[DEBUG] (next update at {get_next_update_time(d)}) on local shell: by command {d.command} with args="{d.args}" got value="{d.value}"')
|
||||||
|
|
||||||
|
|
||||||
|
class UptimeMetric(AbstractMetric):
|
||||||
|
def __init__(self, interval):
|
||||||
|
super().__init__(None, {})
|
||||||
|
self.data_array.append(UptimeData(interval))
|
||||||
|
|
||||||
|
def proceed_metric(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
if d.is_need_to_update():
|
||||||
|
d.set_data()
|
||||||
|
|
||||||
|
def print_debug_info(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
print(f'[DEBUG] (next update at {get_next_update_time(d)}) Uptime: {d.uptime}')
|
||||||
|
|
||||||
|
|
||||||
|
class SystemMetric(AbstractMetric):
|
||||||
|
def __init__(self, interval):
|
||||||
|
super().__init__(None, {})
|
||||||
|
self.data_array.append(SystemData(interval, app_config.INSTANCE_PREFIX))
|
||||||
|
|
||||||
|
def proceed_metric(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
if d.is_need_to_update():
|
||||||
|
d.set_data()
|
||||||
|
|
||||||
|
def print_debug_info(self):
|
||||||
|
for d in self.data_array:
|
||||||
|
print(f'[DEBUG] (next update at {get_next_update_time(d)}) CPU: {d.cpu}% Mem: {d.memory}% Uptime: {d.uptime}s '
|
||||||
|
f'CPU temperature: {d.cpu_temp} Chassis temperature: {d.ch_temp}')
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
pass
|
||||||
0
metrics/__init__.py
Executable file
0
metrics/__init__.py
Executable file
BIN
metrics/__pycache__/DataStructures.cpython-312.pyc
Normal file
BIN
metrics/__pycache__/DataStructures.cpython-312.pyc
Normal file
Binary file not shown.
BIN
metrics/__pycache__/MetricClasses.cpython-312.pyc
Normal file
BIN
metrics/__pycache__/MetricClasses.cpython-312.pyc
Normal file
Binary file not shown.
BIN
metrics/__pycache__/__init__.cpython-312.pyc
Normal file
BIN
metrics/__pycache__/__init__.cpython-312.pyc
Normal file
Binary file not shown.
4
requirements.txt
Executable file
4
requirements.txt
Executable file
@ -0,0 +1,4 @@
|
|||||||
|
prometheus-client~=0.21.1
|
||||||
|
requests~=2.32.3
|
||||||
|
psutil~=6.1.1
|
||||||
|
pyyaml~=6.0.2
|
||||||
Loading…
x
Reference in New Issue
Block a user