Compare commits
13 Commits
064b0ab6ca
...
test
| Author | SHA1 | Date | |
|---|---|---|---|
| 094debc46c | |||
| d2de7f8b02 | |||
| 3b2bebf6b9 | |||
| 059aa81c5c | |||
| 08ba77cdf0 | |||
| bcd2bd627e | |||
| 9e53259e61 | |||
| a61f2bdf30 | |||
| 66b1cc036b | |||
| 060c5cd2db | |||
| 63fcf25989 | |||
| fd4fa07884 | |||
| 0452982fe5 |
661
LICENSE
Normal file
661
LICENSE
Normal file
@@ -0,0 +1,661 @@
|
|||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are 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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
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 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 work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
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 AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
57
partitioning/CHANGELOG.md
Normal file
57
partitioning/CHANGELOG.md
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [0.6.0] - 2025-12-20
|
||||||
|
### Added
|
||||||
|
- **SSL**: Added support for simplified SSL configuration (`ssl: required`) for Managed/Cloud databases and updated Wizard/Config.
|
||||||
|
- **Safety**: Added automatic cleanup of `housekeeper` table during init (targeted) and conflict detection during maintenance.
|
||||||
|
- **CLI**: Added short flags for all arguments (`-vv`, `-f`, `-d`, `-s`, `-w`).
|
||||||
|
- **Validation**: Enforced strict unit validation for retention periods and strict table existence checks.
|
||||||
|
- **Error Handling**: Improved error reporting used to identify specific tables causing configuration errors.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- **CLI**: Refactored `--init` and `--fast-init` into mutually exclusive standalone commands (Breaking Change).
|
||||||
|
- **CLI**: Reorganized argument parsing logic for better maintainability.
|
||||||
|
- **Safety**: Updated initialization warnings to explicitly mention duration ("SEVERAL HOURS") and disk space requirements.
|
||||||
|
- **Logic**: Refined housekeeper conflict check to only warn about tables actively configured for partitioning.
|
||||||
|
|
||||||
|
## [0.5.0] - 2025-12-16
|
||||||
|
### Added
|
||||||
|
- **Wizard**: Added interactive configuration wizard (`--wizard`).
|
||||||
|
- **CLI**: Added `--fast-init` flag to skip table scanning during initialization, instead of config option.
|
||||||
|
- **Monitoring**: Added `--stats` argument to output JSON statistics (Size, Count, Days Left).
|
||||||
|
- **Template**: Updated `zabbix_mysql_partitioning_template.yaml` to use Master/Dependent items for efficient stats collection.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- **Config**: Removed `initial_partitioning_start` from configuration file (moved to `--fast-init`).
|
||||||
|
- **Template**: Replaced legacy check item with comprehensive stats master item.
|
||||||
|
- **CLI**: Removed legacy `--check-days` argument (replaced by `--stats`).
|
||||||
|
|
||||||
|
## [0.4.1] - 2025-12-16
|
||||||
|
### Added
|
||||||
|
- **CLI**: Added `--verbose` / `-v` flag to switch between INFO (default) and DEBUG logging levels.
|
||||||
|
- **CLI**: Added `-r` short flag for `--dry-run`.
|
||||||
|
|
||||||
|
## [0.4.0] - 2025-12-16
|
||||||
|
### Added
|
||||||
|
- **Monitoring**: Added `--discovery` argument for Zabbix Low-Level Discovery (LLD) of partitioned tables.
|
||||||
|
- **Monitoring**: Added `--check-days` argument to calculate days remaining until partition buffer exhaustion.
|
||||||
|
- **CLI**: Added `--version` / `-V` flag to display script version.
|
||||||
|
- **Docker**: Added `RUN_MODE=discovery` and `RUN_MODE=check` support to `entrypoint.py`.
|
||||||
|
- **Templates**: Added Zabbix 7.0 compatible template `zabbix_partitioning_template.yaml`.
|
||||||
|
|
||||||
|
### Removed
|
||||||
|
- **CLI**: Removed unimplemented `--delete` / `-d` argument.
|
||||||
|
|
||||||
|
## [0.3.0] - 2025-12-14
|
||||||
|
### Changed
|
||||||
|
- **Refactor**: Complete rewrite of `zabbix_partitioning.py` using Class-based structure (`ZabbixPartitioner`).
|
||||||
|
- **Configuration**: Extended comments in the configuration file (`zabbix_partitioning.conf`). The config file is self-explanatory now.
|
||||||
|
- **Docker**: Introduced Docker container support (`Dockerfile`, `entrypoint.py`). The script can be run in a stateless manner using Docker.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- **Optimization**: Added `initial_partitioning_start` option (`db_min` vs `retention`) to speed up initialization on large DBs.
|
||||||
@@ -47,8 +47,16 @@ The script manages MySQL table partitions based on time (Range Partitioning on t
|
|||||||
---
|
---
|
||||||
|
|
||||||
## 3. Configuration
|
## 3. Configuration
|
||||||
Edit `/etc/zabbix/zabbix_partitioning.conf`:
|
The preferred way to create the configuration file is using the **Interactive Wizard**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
/opt/zabbix_partitioning/zabbix_partitioning.py --wizard
|
||||||
|
```
|
||||||
|
|
||||||
|
Follow the on-screen prompts to configure your database connection, retention periods, and other settings. The wizard will generate the YAML configuration file for you.
|
||||||
|
|
||||||
|
### Automatic Config Structure (Reference)
|
||||||
|
If you prefer to edit manually `/etc/zabbix/zabbix_partitioning.conf`:
|
||||||
```yaml
|
```yaml
|
||||||
database:
|
database:
|
||||||
host: localhost
|
host: localhost
|
||||||
@@ -56,6 +64,7 @@ database:
|
|||||||
passwd: YOUR_PASSWORD
|
passwd: YOUR_PASSWORD
|
||||||
db: zabbix
|
db: zabbix
|
||||||
# port: 3306 # Optional, default is 3306
|
# port: 3306 # Optional, default is 3306
|
||||||
|
# socket: /var/run/mysqld/mysqld.sock # Overrides host if present
|
||||||
|
|
||||||
partitions:
|
partitions:
|
||||||
daily:
|
daily:
|
||||||
@@ -74,9 +83,7 @@ partitions:
|
|||||||
- **`yearly`**: Partitions are created for each year.
|
- **`yearly`**: Partitions are created for each year.
|
||||||
- Retention Format: `14d` (days), `12w` (weeks), `12m` (months), `1y` (years).
|
- Retention Format: `14d` (days), `12w` (weeks), `12m` (months), `1y` (years).
|
||||||
|
|
||||||
- **`initial_partitioning_start`**: Controls how the very FIRST partition is determined during initialization (`--init` mode).
|
- **`replicate_sql`**: Controls MySQL Binary Logging for partitioning commands.
|
||||||
- `db_min`: (Default) Queries the table for the oldest record (`MIN(clock)`). Accurate but **slow** on large tables.
|
|
||||||
- `retention`: (Recommended for large DBs) Skips the query. Calculates the start date as `Now - Retention Period`. Creates a single `p_archive` partition for all data older than that date.
|
|
||||||
|
|
||||||
- **`premake`**: Number of future partitions to create in advance.
|
- **`premake`**: Number of future partitions to create in advance.
|
||||||
- Default: `10`. Ensures you have a buffer if the script fails to run for a few days.
|
- Default: `10`. Ensures you have a buffer if the script fails to run for a few days.
|
||||||
@@ -90,7 +97,25 @@ partitions:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 4. Zabbix Preparation (CRITICAL)
|
---
|
||||||
|
|
||||||
|
## 4. Runtime Parameters
|
||||||
|
|
||||||
|
| Argument | Description |
|
||||||
|
|---|---|
|
||||||
|
| `-c`, `--config FILE` | Path to configuration file (Default: `/etc/zabbix/zabbix_partitioning.conf`) |
|
||||||
|
| `-i`, `--init` | Initialize partitions (Standard Mode: Scan Table). |
|
||||||
|
| `-f`, `--fast-init` | Initialize partitions (Fast Mode: Skip Scan, use Retention). |
|
||||||
|
| `--wizard` | Launch interactive configuration wizard. |
|
||||||
|
| `-r`, `--dry-run` | Simulate queries without executing. Logs expected actions (Safe mode). |
|
||||||
|
| `-v`, `--verbose` | Enable debug logging (DEBUG level). |
|
||||||
|
| `--stats TABLE` | Output JSON statistics (Size, Count, Days Left) for a specific table. |
|
||||||
|
| `--discovery` | Output Zabbix Low-Level Discovery (LLD) JSON. |
|
||||||
|
| `-V`, `--version` | Show script version. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5. Zabbix Preparation (CRITICAL)
|
||||||
Before partitioning, you **must disable** Zabbix's internal housekeeping for the tables you intend to partition. If you don't, Zabbix will try to delete individual rows while the script tries to drop partitions, causing conflicts.
|
Before partitioning, you **must disable** Zabbix's internal housekeeping for the tables you intend to partition. If you don't, Zabbix will try to delete individual rows while the script tries to drop partitions, causing conflicts.
|
||||||
|
|
||||||
1. Log in to Zabbix Web Interface.
|
1. Log in to Zabbix Web Interface.
|
||||||
@@ -102,38 +127,52 @@ Before partitioning, you **must disable** Zabbix's internal housekeeping for the
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 5. Initialization
|
## 6. Initialization
|
||||||
This step converts existing standard tables into partitioned tables.
|
This step converts existing standard tables into partitioned tables.
|
||||||
|
|
||||||
1. **Dry Run** (Verify what will happen):
|
1. **Dry Run** (Verify what will happen):
|
||||||
```bash
|
```bash
|
||||||
/opt/zabbix_partitioning/zabbix_partitioning.py --init --dry-run
|
/opt/zabbix_partitioning/zabbix_partitioning.py --init --dry-run
|
||||||
```
|
```
|
||||||
*Check the output for any errors.*
|
|
||||||
|
|
||||||
2. **Execute Initialization**:
|
2. **Execute Initialization**:
|
||||||
|
> [!WARNING]
|
||||||
|
> For large databases, standard initialization may take **SEVERAL HOURS** and require significant disk space (approx 2x table size).
|
||||||
|
|
||||||
|
There are two strategies for initialization:
|
||||||
|
|
||||||
|
**A. Standard Initialization (`--init`)**:
|
||||||
|
Scans the database to find the oldest record (`MIN(clock)`) and creates partitions from that point forward.
|
||||||
|
*Best for smaller databases or when you need to retain ALL existing data.*
|
||||||
```bash
|
```bash
|
||||||
/opt/zabbix_partitioning/zabbix_partitioning.py --init
|
/opt/zabbix_partitioning/zabbix_partitioning.py --init
|
||||||
```
|
```
|
||||||
*This may take time depending on table size.*
|
|
||||||
|
**B. Fast Initialization (`--fast-init`)**:
|
||||||
|
Skips the slow table scan. It calculates the start date based on your configured **Retention Period** (e.g., `Now - 365d`).
|
||||||
|
It creates a single catch-all `p_archive` partition for all data older than the retention start date, then creates granular partitions forward.
|
||||||
|
*Recommended for large databases to avoid long table locks/scans.*
|
||||||
|
```bash
|
||||||
|
/opt/zabbix_partitioning/zabbix_partitioning.py --fast-init
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 6. Automation (Cron Job)
|
## 7. Automation (Cron Job)
|
||||||
Set up a daily cron job to create new partitions and remove old ones.
|
Set up a cron job to create new partitions and remove old ones.
|
||||||
|
|
||||||
1. Open crontab:
|
1. Open crontab:
|
||||||
```bash
|
```bash
|
||||||
crontab -e
|
crontab -e
|
||||||
```
|
```
|
||||||
2. Add the line (run daily at 00:30):
|
2. Add the line (run twice a day at 00:10 and 04:10):
|
||||||
```cron
|
```cron
|
||||||
30 0 * * * /usr/bin/python3 /opt/zabbix_partitioning/zabbix_partitioning.py -c /etc/zabbix/zabbix_partitioning.conf >> /var/log/zabbix_partitioning.log 2>&1
|
10 0,4 * * * /usr/bin/python3 /opt/zabbix_partitioning/zabbix_partitioning.py -c /etc/zabbix/zabbix_partitioning.conf >> /var/log/zabbix_partitioning.log 2>&1
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 7. Automation (Systemd Timer) — Recommended
|
## 8. Automation (Systemd Timer) — Recommended
|
||||||
Alternatively, use systemd timers for more robust scheduling and logging.
|
Alternatively, use systemd timers for more robust scheduling and logging.
|
||||||
|
|
||||||
1. **Create Service Unit** (`/etc/systemd/system/zabbix-partitioning.service`):
|
1. **Create Service Unit** (`/etc/systemd/system/zabbix-partitioning.service`):
|
||||||
@@ -151,10 +190,10 @@ Alternatively, use systemd timers for more robust scheduling and logging.
|
|||||||
2. **Create Timer Unit** (`/etc/systemd/system/zabbix-partitioning.timer`):
|
2. **Create Timer Unit** (`/etc/systemd/system/zabbix-partitioning.timer`):
|
||||||
```ini
|
```ini
|
||||||
[Unit]
|
[Unit]
|
||||||
Description=Run Zabbix Partitioning Daily
|
Description=Run Zabbix Partitioning twice a day
|
||||||
|
|
||||||
[Timer]
|
[Timer]
|
||||||
OnCalendar=*-*-* 00:30:00
|
OnCalendar=*-*-* 00:10:00 *-*-* 04:10:00
|
||||||
Persistent=true
|
Persistent=true
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
@@ -176,12 +215,12 @@ Alternatively, use systemd timers for more robust scheduling and logging.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 8. Troubleshooting
|
## 9. Troubleshooting
|
||||||
- **Connection Refused**: Check `host`, `port` in config. Ensure MySQL is running.
|
- **Connection Refused**: Check `host`, `port` in config. Ensure MySQL is running.
|
||||||
- **Access Denied (1227)**: The DB user needs `SUPER` privileges to disable binary logging (`replicate_sql: False`). Either grant the privilege or set `replicate_sql: True` (if replication load is acceptable).
|
- **Access Denied (1227)**: The DB user needs `SUPER` privileges to disable binary logging (`replicate_sql: False`). Either grant the privilege or set `replicate_sql: True` (if replication load is acceptable).
|
||||||
- **Primary Key Error**: "Primary Key does not include 'clock'". The table cannot be partitioned by range on `clock` without schema changes. Remove it from config.
|
- **Primary Key Error**: "Primary Key does not include 'clock'". The table cannot be partitioned by range on `clock` without schema changes. Remove it from config.
|
||||||
|
|
||||||
## 9. Docker Usage
|
## 10. Docker Usage
|
||||||
|
|
||||||
You can run the partitioning script as a stateless Docker container. This is ideal for Kubernetes CronJobs or environments where you don't want to manage Python dependencies on the host.
|
You can run the partitioning script as a stateless Docker container. This is ideal for Kubernetes CronJobs or environments where you don't want to manage Python dependencies on the host.
|
||||||
|
|
||||||
@@ -267,8 +306,65 @@ docker run --rm \
|
|||||||
| `RETENTION_TRENDS` | 365d | Retention for `trends*` tables |
|
| `RETENTION_TRENDS` | 365d | Retention for `trends*` tables |
|
||||||
| `RETENTION_AUDIT` | 365d | Retention for `auditlog` (if enabled) |
|
| `RETENTION_AUDIT` | 365d | Retention for `auditlog` (if enabled) |
|
||||||
| `ENABLE_AUDITLOG_PARTITIONING` | false | Set to `true` to partition `auditlog` |
|
| `ENABLE_AUDITLOG_PARTITIONING` | false | Set to `true` to partition `auditlog` |
|
||||||
| `RUN_MODE` | maintenance | `init` (initialize), `maintenance` (daily run), or `dry-run` |
|
| `RUN_MODE` | maintenance | `init`, `maintenance`, `dry-run`, `discovery`, `stats` |
|
||||||
|
| `CHECK_TARGET` | - | Required if `RUN_MODE=stats`. Table name to check (e.g. `history`). |
|
||||||
| `PARTITION_DAILY_[TABLE]` | - | Custom daily retention (e.g., `PARTITION_DAILY_mytable=30d`) |
|
| `PARTITION_DAILY_[TABLE]` | - | Custom daily retention (e.g., `PARTITION_DAILY_mytable=30d`) |
|
||||||
| `PARTITION_WEEKLY_[TABLE]` | - | Custom weekly retention |
|
| `PARTITION_WEEKLY_[TABLE]` | - | Custom weekly retention |
|
||||||
| `PARTITION_MONTHLY_[TABLE]` | - | Custom monthly retention |
|
| `PARTITION_MONTHLY_[TABLE]` | - | Custom monthly retention |
|
||||||
|
|
||||||
|
#### Scenario F: Monitoring (Discovery)
|
||||||
|
Output Zabbix LLD JSON for table discovery.
|
||||||
|
```bash
|
||||||
|
docker run --rm \
|
||||||
|
-e DB_HOST=zabbix-db \
|
||||||
|
-e RUN_MODE=discovery \
|
||||||
|
zabbix-partitioning
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Scenario G: Monitoring (Stats)
|
||||||
|
Get detailed JSON statistics for a specific table.
|
||||||
|
```bash
|
||||||
|
docker run --rm \
|
||||||
|
-e DB_HOST=zabbix-db \
|
||||||
|
-e RUN_MODE=stats \
|
||||||
|
-e CHECK_TARGET=history \
|
||||||
|
zabbix-partitioning
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 11. Monitoring
|
||||||
|
The script includes built-in features for monitoring the health of your partitions via Zabbix.
|
||||||
|
|
||||||
|
### 10.1 CLI Usage
|
||||||
|
- **Discovery (LLD)**:
|
||||||
|
Output the list of configured tables for Zabbix Discovery rules.
|
||||||
|
```bash
|
||||||
|
./zabbix_partitioning.py --discovery
|
||||||
|
# Output: [{"{#TABLE}": "history", "{#PERIOD}": "daily"}, ...]
|
||||||
|
```
|
||||||
|
- **Statistics (JSON)**:
|
||||||
|
Get detailed stats (Size, Partition Count, Days Remaining).
|
||||||
|
```bash
|
||||||
|
./zabbix_partitioning.py --stats history
|
||||||
|
# Output: {"table": "history", "size_bytes": 102400, "partition_count": 5, "days_left": 30}
|
||||||
|
```
|
||||||
|
- **Version**:
|
||||||
|
```bash
|
||||||
|
./zabbix_partitioning.py --version
|
||||||
|
```
|
||||||
|
|
||||||
|
### 10.2 Zabbix Template
|
||||||
|
A Zabbix 7.0 template is provided: `zabbix_partitioning_template.yaml`.
|
||||||
|
|
||||||
|
**Setup**:
|
||||||
|
1. Import the YAML template into Zabbix.
|
||||||
|
2. Install the script on the Zabbix Server or Proxy.
|
||||||
|
3. Add the `UserParameter` commands to your Zabbix Agent config (see Template description).
|
||||||
|
4. Link the template to the host running the script.
|
||||||
|
|
||||||
|
**Features**:
|
||||||
|
- **Discovery**: Automatically finds all partitioned tables.
|
||||||
|
- **Triggers**: Alerts if a table has less than 3 days of future partitions pre-created.
|
||||||
|
- **Log Monitoring**: Alerts on script execution failures.
|
||||||
|
|
||||||
|
|||||||
@@ -105,6 +105,13 @@ def main():
|
|||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
cmd.append('--check-days')
|
cmd.append('--check-days')
|
||||||
cmd.append(target)
|
cmd.append(target)
|
||||||
|
elif run_mode == 'stats':
|
||||||
|
target = os.getenv('CHECK_TARGET')
|
||||||
|
if not target:
|
||||||
|
print("Error: CHECK_TARGET env var required for stats mode")
|
||||||
|
sys.exit(1)
|
||||||
|
cmd.append('--stats')
|
||||||
|
cmd.append(target)
|
||||||
|
|
||||||
print(f"Executing: {' '.join(cmd)}")
|
print(f"Executing: {' '.join(cmd)}")
|
||||||
result = subprocess.run(cmd)
|
result = subprocess.run(cmd)
|
||||||
|
|||||||
@@ -2,15 +2,20 @@
|
|||||||
database:
|
database:
|
||||||
type: mysql
|
type: mysql
|
||||||
# host: Database server hostname or IP
|
# host: Database server hostname or IP
|
||||||
host: localhost
|
# host: localhost
|
||||||
# socket: Path to the MySQL unix socket (overrides host if set)
|
# socket: Path to the MySQL unix socket (overrides host if set)
|
||||||
socket: /var/run/mysqlrouter/mysql_rw.sock
|
socket: /var/run/mysqld/mysqld.sock
|
||||||
# port: Database port (default: 3306)
|
# port: Database port (default: 3306)
|
||||||
# port: 3306
|
# port: 3306
|
||||||
# credentials
|
# credentials
|
||||||
user: zbx_part
|
user: zbx_part
|
||||||
passwd: <password>
|
passwd: <password>
|
||||||
db: zabbix
|
db: zabbix
|
||||||
|
# ssl: required # Use system CAs (Mandatory for Azure/AWS/GCP)
|
||||||
|
# ssl: # Or use custom certificates
|
||||||
|
# ca: /etc/ssl/certs/ca-cert.pem
|
||||||
|
# cert: /etc/ssl/certs/client-cert.pem
|
||||||
|
# key: /etc/ssl/certs/client-key.pem
|
||||||
|
|
||||||
# partitions: Define retention periods for tables.
|
# partitions: Define retention periods for tables.
|
||||||
# Format: table_name: duration (e.g., 14d, 12w, 1m, 1y)
|
# Format: table_name: duration (e.g., 14d, 12w, 1m, 1y)
|
||||||
@@ -26,9 +31,8 @@ partitions:
|
|||||||
# weekly: Partitions created weekly
|
# weekly: Partitions created weekly
|
||||||
weekly:
|
weekly:
|
||||||
# - auditlog: 180d
|
# - auditlog: 180d
|
||||||
# Note: auditlog is not partitionable by default in Zabbix 7.0 and 7.4 (PK missing clock).
|
# Note: auditlog is not partitionable by default in Zabbix 7.0 (PK missing clock).
|
||||||
# To partition, the Primary Key must be altered to include 'clock'.
|
# To partition, the Primary Key must be altered to include 'clock'.
|
||||||
# https://www.zabbix.com/documentation/current/en/manual/appendix/install/auditlog_primary_keys
|
|
||||||
# monthly: Partitions created monthly
|
# monthly: Partitions created monthly
|
||||||
monthly:
|
monthly:
|
||||||
- trends: 1y
|
- trends: 1y
|
||||||
@@ -40,14 +44,6 @@ logging: syslog
|
|||||||
# premake: Number of partitions to create in advance
|
# premake: Number of partitions to create in advance
|
||||||
premake: 10
|
premake: 10
|
||||||
|
|
||||||
# initial_partitioning_start: Strategy for the first partition during initialization (--init).
|
|
||||||
# Options:
|
|
||||||
# db_min: (Default) Queries SELECT MIN(clock) to ensure ALL data is covered. Slow on huge tables consistently.
|
|
||||||
# retention: Starts partitioning from (Now - Retention Period).
|
|
||||||
# Creates a 'p_archive' partition for all data older than retention.
|
|
||||||
# Much faster as it skips the MIN(clock) query. (Recommended for large DBs)
|
|
||||||
initial_partitioning_start: db_min
|
|
||||||
|
|
||||||
# replicate_sql: False - Disable binary logging. Partitioning changes are NOT replicated to slaves (use for independent maintenance).
|
# replicate_sql: False - Disable binary logging. Partitioning changes are NOT replicated to slaves (use for independent maintenance).
|
||||||
# replicate_sql: True - Enable binary logging. Partitioning changes ARE replicated to slaves (use for consistent cluster schema).
|
# replicate_sql: True - Enable binary logging. Partitioning changes ARE replicated to slaves (use for consistent cluster schema).
|
||||||
replicate_sql: False
|
replicate_sql: False
|
||||||
483
partitioning/script/zabbix_partitioning.py
Normal file → Executable file
483
partitioning/script/zabbix_partitioning.py
Normal file → Executable file
@@ -1,9 +1,8 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
"""
|
"""
|
||||||
Zabbix Database Partitioning Management Script
|
Zabbix MySQL Partitioning Script
|
||||||
|
|
||||||
Refactored for Zabbix 7.x compatibility, better maintainability, and standard logging.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
@@ -21,7 +20,7 @@ from typing import Optional, Dict, List, Any, Union, Tuple
|
|||||||
from contextlib import contextmanager
|
from contextlib import contextmanager
|
||||||
|
|
||||||
# Semantic Versioning
|
# Semantic Versioning
|
||||||
VERSION = '0.3.0'
|
VERSION = '0.6.0'
|
||||||
|
|
||||||
# Constants
|
# Constants
|
||||||
PART_PERIOD_REGEX = r'([0-9]+)(h|d|m|y)'
|
PART_PERIOD_REGEX = r'([0-9]+)(h|d|m|y)'
|
||||||
@@ -35,9 +34,10 @@ class DatabaseError(Exception):
|
|||||||
pass
|
pass
|
||||||
|
|
||||||
class ZabbixPartitioner:
|
class ZabbixPartitioner:
|
||||||
def __init__(self, config: Dict[str, Any], dry_run: bool = False):
|
def __init__(self, config: Dict[str, Any], dry_run: bool = False, fast_init: bool = False):
|
||||||
self.config = config
|
self.config = config
|
||||||
self.dry_run = dry_run
|
self.dry_run = dry_run
|
||||||
|
self.fast_init = fast_init
|
||||||
self.conn = None
|
self.conn = None
|
||||||
self.logger = logging.getLogger('zabbix_partitioning')
|
self.logger = logging.getLogger('zabbix_partitioning')
|
||||||
|
|
||||||
@@ -73,6 +73,11 @@ class ZabbixPartitioner:
|
|||||||
connect_args['host'] = self.db_host
|
connect_args['host'] = self.db_host
|
||||||
|
|
||||||
if self.db_ssl:
|
if self.db_ssl:
|
||||||
|
if self.db_ssl is True or (isinstance(self.db_ssl, str) and self.db_ssl.lower() == 'required'):
|
||||||
|
# Enable SSL with default context (uses system CAs)
|
||||||
|
# Useful for Cloud DBs (Azure, AWS) that require TLS by default
|
||||||
|
connect_args['ssl'] = {}
|
||||||
|
else:
|
||||||
connect_args['ssl'] = self.db_ssl
|
connect_args['ssl'] = self.db_ssl
|
||||||
# PyMySQL SSL options
|
# PyMySQL SSL options
|
||||||
# Note: valid ssl keys for PyMySQL are 'ca', 'capath', 'cert', 'key', 'cipher', 'check_hostname'
|
# Note: valid ssl keys for PyMySQL are 'ca', 'capath', 'cert', 'key', 'cipher', 'check_hostname'
|
||||||
@@ -176,9 +181,11 @@ class ZabbixPartitioner:
|
|||||||
"""
|
"""
|
||||||
Calculate the retention date based on config string (e.g., "30d", "12m").
|
Calculate the retention date based on config string (e.g., "30d", "12m").
|
||||||
"""
|
"""
|
||||||
|
# Ensure string
|
||||||
|
period_str = str(period_str)
|
||||||
match = re.search(PART_PERIOD_REGEX, period_str)
|
match = re.search(PART_PERIOD_REGEX, period_str)
|
||||||
if not match:
|
if not match:
|
||||||
raise ConfigurationError(f"Invalid period format: {period_str}")
|
raise ConfigurationError(f"Invalid period format: '{period_str}' (Expected format like 30d, 12w, 1y)")
|
||||||
|
|
||||||
amount = int(match.group(1))
|
amount = int(match.group(1))
|
||||||
unit = match.group(2)
|
unit = match.group(2)
|
||||||
@@ -232,10 +239,9 @@ class ZabbixPartitioner:
|
|||||||
raise DatabaseError("Could not determine MySQL version")
|
raise DatabaseError("Could not determine MySQL version")
|
||||||
|
|
||||||
# MySQL 8.0+ supports partitioning natively
|
# MySQL 8.0+ supports partitioning natively
|
||||||
# (Assuming MySQL 8+ or MariaDB 10+ for modern Zabbix)
|
|
||||||
self.logger.info(f"MySQL Version: {version_str}")
|
self.logger.info(f"MySQL Version: {version_str}")
|
||||||
|
|
||||||
# 2. Check Zabbix DB Version (optional info)
|
# 2. Check Zabbix DB Version
|
||||||
try:
|
try:
|
||||||
mandatory = self.execute_query('SELECT `mandatory` FROM `dbversion`', fetch='one')
|
mandatory = self.execute_query('SELECT `mandatory` FROM `dbversion`', fetch='one')
|
||||||
if mandatory:
|
if mandatory:
|
||||||
@@ -243,6 +249,18 @@ class ZabbixPartitioner:
|
|||||||
except Exception:
|
except Exception:
|
||||||
self.logger.warning("Could not read 'dbversion' table. Is this a Zabbix DB?")
|
self.logger.warning("Could not read 'dbversion' table. Is this a Zabbix DB?")
|
||||||
|
|
||||||
|
def validate_table_exists(self, table: str) -> bool:
|
||||||
|
"""Return True if table exists in the database."""
|
||||||
|
# Use simple select from information_schema
|
||||||
|
exists = self.execute_query(
|
||||||
|
"SELECT 1 FROM information_schema.tables WHERE table_schema = %s AND table_name = %s",
|
||||||
|
(self.db_name, table), fetch='one'
|
||||||
|
)
|
||||||
|
if not exists:
|
||||||
|
self.logger.error(f"Table '{table}' does NOT exist in database '{self.db_name}'. Skipped.")
|
||||||
|
return False
|
||||||
|
return True
|
||||||
|
|
||||||
def get_table_min_clock(self, table: str) -> Optional[datetime]:
|
def get_table_min_clock(self, table: str) -> Optional[datetime]:
|
||||||
ts = self.execute_query(f"SELECT MIN(`clock`) FROM `{table}`", fetch='one')
|
ts = self.execute_query(f"SELECT MIN(`clock`) FROM `{table}`", fetch='one')
|
||||||
return datetime.fromtimestamp(int(ts)) if ts else None
|
return datetime.fromtimestamp(int(ts)) if ts else None
|
||||||
@@ -372,78 +390,131 @@ class ZabbixPartitioner:
|
|||||||
for name in to_drop:
|
for name in to_drop:
|
||||||
self.execute_query(f"ALTER TABLE `{table}` DROP PARTITION {name}")
|
self.execute_query(f"ALTER TABLE `{table}` DROP PARTITION {name}")
|
||||||
|
|
||||||
def initialize_partitioning(self, table: str, period: str, premake: int, retention_str: str):
|
|
||||||
"""Initial partitioning for a table (convert regular table to partitioned)."""
|
|
||||||
self.logger.info(f"Initializing partitioning for {table}")
|
|
||||||
|
|
||||||
|
|
||||||
|
def _check_init_prerequisites(self, table: str) -> bool:
|
||||||
|
"""Return True if partitioning can proceed."""
|
||||||
if self.has_incompatible_primary_key(table):
|
if self.has_incompatible_primary_key(table):
|
||||||
self.logger.error(f"Cannot partition {table}: Primary Key does not include 'clock' column.")
|
self.logger.error(f"Cannot partition {table}: Primary Key does not include 'clock' column.")
|
||||||
return
|
return False
|
||||||
|
|
||||||
# If already partitioned, skip
|
|
||||||
if self.get_existing_partitions(table):
|
if self.get_existing_partitions(table):
|
||||||
self.logger.info(f"Table {table} is already partitioned.")
|
self.logger.info(f"Table {table} is already partitioned.")
|
||||||
return
|
return False
|
||||||
|
|
||||||
init_strategy = self.config.get('initial_partitioning_start', 'db_min')
|
# Disk Space & Lock Warning
|
||||||
start_dt = None
|
msg = (
|
||||||
p_archive_ts = None
|
f"WARNING: Partitioning table '{table}' requires creating a copy of the table.\n"
|
||||||
|
f" Ensure you have free disk space >= Data_Length + Index_Length (approx 2x table size).\n"
|
||||||
|
f" For large databases, this operation may take SEVERAL HOURS to complete."
|
||||||
|
)
|
||||||
|
self.logger.warning(msg)
|
||||||
|
|
||||||
if init_strategy == 'retention':
|
# Interactive Check
|
||||||
self.logger.info(f"Strategy 'retention': Calculating start date from retention ({retention_str})")
|
if sys.stdin.isatty():
|
||||||
retention_date = self.get_lookback_date(retention_str)
|
print(f"\n{msg}")
|
||||||
# Start granular partitions from the retention date
|
if input("Do you have enough free space and is Zabbix stopped? [y/N]: ").lower().strip() != 'y':
|
||||||
start_dt = self.truncate_date(retention_date, period)
|
self.logger.error("Initialization aborted by user.")
|
||||||
# Create a catch-all for anything older
|
return False
|
||||||
p_archive_ts = int(start_dt.timestamp())
|
|
||||||
else:
|
|
||||||
# Default 'db_min' strategy
|
|
||||||
self.logger.info("Strategy 'db_min': Querying table for minimum clock (may be slow)")
|
|
||||||
min_clock = self.get_table_min_clock(table)
|
|
||||||
|
|
||||||
if not min_clock:
|
return True
|
||||||
# Empty table. Start from NOW
|
|
||||||
start_dt = self.truncate_date(datetime.now(), period)
|
|
||||||
else:
|
|
||||||
# Table has data.
|
|
||||||
start_dt = self.truncate_date(min_clock, period)
|
|
||||||
|
|
||||||
# Build list of partitions from start_dt up to NOW + premake
|
def _generate_init_sql(self, table: str, period: str, start_dt: datetime, premake: int, p_archive_ts: int = None):
|
||||||
|
"""Generate and execute ALTER TABLE command."""
|
||||||
target_dt = self.get_next_date(self.truncate_date(datetime.now(), period), period, premake)
|
target_dt = self.get_next_date(self.truncate_date(datetime.now(), period), period, premake)
|
||||||
|
|
||||||
curr = start_dt
|
|
||||||
partitions_def = {}
|
|
||||||
|
|
||||||
# If we have an archive partition, add it first
|
|
||||||
if p_archive_ts:
|
|
||||||
partitions_def['p_archive'] = str(p_archive_ts)
|
|
||||||
|
|
||||||
while curr < target_dt:
|
|
||||||
name = self.get_partition_name(curr, period)
|
|
||||||
desc = self.get_partition_description(curr, period)
|
|
||||||
partitions_def[name] = desc
|
|
||||||
curr = self.get_next_date(curr, period, 1)
|
|
||||||
|
|
||||||
# Re-doing the loop to be cleaner on types
|
|
||||||
parts_sql = []
|
parts_sql = []
|
||||||
|
|
||||||
# 1. Archive Partition
|
|
||||||
if p_archive_ts:
|
if p_archive_ts:
|
||||||
parts_sql.append(f"PARTITION p_archive VALUES LESS THAN ({p_archive_ts}) ENGINE = InnoDB")
|
parts_sql.append(f"PARTITION p_archive VALUES LESS THAN ({p_archive_ts}) ENGINE = InnoDB")
|
||||||
|
|
||||||
# 2. Granular Partitions
|
|
||||||
# We need to iterate again from start_dt
|
|
||||||
curr = start_dt
|
curr = start_dt
|
||||||
while curr < target_dt:
|
while curr < target_dt:
|
||||||
name = self.get_partition_name(curr, period)
|
name = self.get_partition_name(curr, period)
|
||||||
desc_date_str = self.get_partition_description(curr, period) # Returns "YYYY-MM-DD HH:MM:SS"
|
desc_date_str = self.get_partition_description(curr, period)
|
||||||
parts_sql.append(PARTITION_TEMPLATE % (name, desc_date_str))
|
parts_sql.append(PARTITION_TEMPLATE % (name, desc_date_str))
|
||||||
curr = self.get_next_date(curr, period, 1)
|
curr = self.get_next_date(curr, period, 1)
|
||||||
|
|
||||||
|
if not parts_sql:
|
||||||
|
self.logger.warning(f"No partitions generated for {table}")
|
||||||
|
return
|
||||||
|
|
||||||
query = f"ALTER TABLE `{table}` PARTITION BY RANGE (`clock`) (\n" + ",\n".join(parts_sql) + "\n)"
|
query = f"ALTER TABLE `{table}` PARTITION BY RANGE (`clock`) (\n" + ",\n".join(parts_sql) + "\n)"
|
||||||
self.logger.info(f"Applying initial partitioning to {table} ({len(parts_sql)} partitions)")
|
self.logger.info(f"Applying initial partitioning to {table} ({len(parts_sql)} partitions)")
|
||||||
self.execute_query(query)
|
self.execute_query(query)
|
||||||
|
|
||||||
|
def _get_configured_tables(self) -> List[str]:
|
||||||
|
"""Return a list of all tables configured for partitioning."""
|
||||||
|
tables_set = set()
|
||||||
|
partitions_conf = self.config.get('partitions', {})
|
||||||
|
for tables in partitions_conf.values():
|
||||||
|
if not tables: continue
|
||||||
|
for item in tables:
|
||||||
|
tables_set.add(list(item.keys())[0])
|
||||||
|
return list(tables_set)
|
||||||
|
|
||||||
|
def clean_housekeeper_table(self):
|
||||||
|
"""
|
||||||
|
Clean up Zabbix housekeeper table during initialization.
|
||||||
|
Removes pending tasks ONLY for configured tables to prevent conflicts.
|
||||||
|
"""
|
||||||
|
configured_tables = self._get_configured_tables()
|
||||||
|
if not configured_tables:
|
||||||
|
return
|
||||||
|
|
||||||
|
self.logger.info(f"Cleaning up 'housekeeper' table for: {', '.join(configured_tables)}")
|
||||||
|
|
||||||
|
# Construct IN clause
|
||||||
|
placeholders = ', '.join(['%s'] * len(configured_tables))
|
||||||
|
query = f"DELETE FROM `housekeeper` WHERE `tablename` IN ({placeholders})"
|
||||||
|
self.execute_query(query, configured_tables)
|
||||||
|
|
||||||
|
def check_housekeeper_execution(self):
|
||||||
|
"""
|
||||||
|
Check if Zabbix internal housekeeper is running for configured partitioned tables.
|
||||||
|
"""
|
||||||
|
configured_tables = self._get_configured_tables()
|
||||||
|
if not configured_tables:
|
||||||
|
return
|
||||||
|
|
||||||
|
query = "SELECT DISTINCT `tablename` FROM `housekeeper` WHERE `tablename` != 'events'"
|
||||||
|
rows = self.execute_query(query, fetch='all')
|
||||||
|
|
||||||
|
if rows:
|
||||||
|
found_tables = {r[0] for r in rows}
|
||||||
|
configured_set = set(configured_tables)
|
||||||
|
conflicts = found_tables.intersection(configured_set)
|
||||||
|
|
||||||
|
if conflicts:
|
||||||
|
self.logger.error(f"CRITICAL: Found pending housekeeper tasks for partitioned tables: {', '.join(conflicts)}")
|
||||||
|
self.logger.error("Please DISABLE Zabbix internal housekeeper for these tables in Administration -> General -> Housekeeping!")
|
||||||
|
|
||||||
|
def initialize_partitioning_fast(self, table: str, period: str, premake: int, retention_str: str):
|
||||||
|
"""Fast Init: Use retention period to determine start date."""
|
||||||
|
self.logger.info(f"Initializing partitioning for {table} (Fast Mode)")
|
||||||
|
if not self._check_init_prerequisites(table): return
|
||||||
|
|
||||||
|
self.logger.info(f"Strategy 'fast-init': Calculating start date from retention ({retention_str})")
|
||||||
|
retention_date = self.get_lookback_date(retention_str)
|
||||||
|
start_dt = self.truncate_date(retention_date, period)
|
||||||
|
p_archive_ts = int(start_dt.timestamp())
|
||||||
|
|
||||||
|
self._generate_init_sql(table, period, start_dt, premake, p_archive_ts)
|
||||||
|
|
||||||
|
def initialize_partitioning_scan(self, table: str, period: str, premake: int):
|
||||||
|
"""Scan Init: Scan table for minimum clock value."""
|
||||||
|
self.logger.info(f"Initializing partitioning for {table} (Scan Mode)")
|
||||||
|
if not self._check_init_prerequisites(table): return
|
||||||
|
|
||||||
|
self.logger.info("Strategy 'db_min': Querying table for minimum clock (may be slow)")
|
||||||
|
min_clock = self.get_table_min_clock(table)
|
||||||
|
|
||||||
|
if not min_clock:
|
||||||
|
start_dt = self.truncate_date(datetime.now(), period)
|
||||||
|
else:
|
||||||
|
start_dt = self.truncate_date(min_clock, period)
|
||||||
|
|
||||||
|
self._generate_init_sql(table, period, start_dt, premake)
|
||||||
|
|
||||||
def discovery(self):
|
def discovery(self):
|
||||||
"""Output Zabbix Low-Level Discovery logic JSON."""
|
"""Output Zabbix Low-Level Discovery logic JSON."""
|
||||||
partitions_conf = self.config.get('partitions', {})
|
partitions_conf = self.config.get('partitions', {})
|
||||||
@@ -481,6 +552,51 @@ class ZabbixPartitioner:
|
|||||||
diff = end_dt - now
|
diff = end_dt - now
|
||||||
return max(0, diff.days)
|
return max(0, diff.days)
|
||||||
|
|
||||||
|
def get_table_stats(self, table: str) -> Dict[str, Any]:
|
||||||
|
"""
|
||||||
|
Get detailed statistics for a table:
|
||||||
|
- size_bytes (data + index)
|
||||||
|
- partition_count
|
||||||
|
- days_left (coverage)
|
||||||
|
"""
|
||||||
|
# 1. Get Size
|
||||||
|
size_query = """
|
||||||
|
SELECT (DATA_LENGTH + INDEX_LENGTH)
|
||||||
|
FROM information_schema.TABLES
|
||||||
|
WHERE TABLE_SCHEMA = %s AND TABLE_NAME = %s
|
||||||
|
"""
|
||||||
|
size_bytes = self.execute_query(size_query, (self.db_name, table), fetch='one')
|
||||||
|
|
||||||
|
# 2. Get Partition Count
|
||||||
|
count_query = """
|
||||||
|
SELECT COUNT(*)
|
||||||
|
FROM information_schema.PARTITIONS
|
||||||
|
WHERE TABLE_SCHEMA = %s AND TABLE_NAME = %s AND PARTITION_NAME IS NOT NULL
|
||||||
|
"""
|
||||||
|
p_count = self.execute_query(count_query, (self.db_name, table), fetch='one')
|
||||||
|
|
||||||
|
# 3. Get Days Left
|
||||||
|
# We need the period first.
|
||||||
|
partitions_conf = self.config.get('partitions', {})
|
||||||
|
found_period = None
|
||||||
|
for period, tables in partitions_conf.items():
|
||||||
|
for item in tables:
|
||||||
|
if list(item.keys())[0] == table:
|
||||||
|
found_period = period
|
||||||
|
break
|
||||||
|
if found_period: break
|
||||||
|
|
||||||
|
days_left = -1
|
||||||
|
if found_period:
|
||||||
|
days_left = self.check_partitions_coverage(table, found_period)
|
||||||
|
|
||||||
|
return {
|
||||||
|
"table": table,
|
||||||
|
"size_bytes": int(size_bytes) if size_bytes is not None else 0,
|
||||||
|
"partition_count": int(p_count) if p_count is not None else 0,
|
||||||
|
"days_left": days_left
|
||||||
|
}
|
||||||
|
|
||||||
def run(self, mode: str, target_table: str = None):
|
def run(self, mode: str, target_table: str = None):
|
||||||
"""Main execution loop."""
|
"""Main execution loop."""
|
||||||
with self.connect_db():
|
with self.connect_db():
|
||||||
@@ -491,40 +607,23 @@ class ZabbixPartitioner:
|
|||||||
self.discovery()
|
self.discovery()
|
||||||
return
|
return
|
||||||
|
|
||||||
# --- Check Mode ---
|
# --- Stats Mode ---
|
||||||
if mode == 'check':
|
if mode == 'stats':
|
||||||
if not target_table:
|
if not target_table:
|
||||||
# Check all and print simple status? Or error?
|
raise ConfigurationError("Target table required for stats mode")
|
||||||
# Zabbix usually queries one by one.
|
|
||||||
# Implementing simple check which returns days for specific table
|
|
||||||
raise ConfigurationError("Target table required for check mode")
|
|
||||||
|
|
||||||
# Find period for table
|
stats = self.get_table_stats(target_table)
|
||||||
found_period = None
|
print(json.dumps(stats))
|
||||||
for period, tables in partitions_conf.items():
|
|
||||||
for item in tables:
|
|
||||||
if list(item.keys())[0] == target_table:
|
|
||||||
found_period = period
|
|
||||||
break
|
|
||||||
if found_period: break
|
|
||||||
|
|
||||||
if not found_period:
|
|
||||||
# Table not in config?
|
|
||||||
print("-1") # Error code
|
|
||||||
return
|
|
||||||
|
|
||||||
days_left = self.check_partitions_coverage(target_table, found_period)
|
|
||||||
print(days_left)
|
|
||||||
return
|
return
|
||||||
|
|
||||||
# --- Normal Mode (Init/Maintain) ---
|
# --- Normal Mode (Init/Maintain) ---
|
||||||
self.check_compatibility()
|
self.check_compatibility()
|
||||||
premake = self.config.get('premake', 10)
|
premake = self.config.get('premake', 10)
|
||||||
|
|
||||||
if mode == 'delete':
|
if mode == 'init':
|
||||||
self.logger.warning("Delete Mode: Removing ALL partitioning from configured tables is not fully implemented in refactor yet.")
|
self.clean_housekeeper_table()
|
||||||
# Implement if needed, usually just ALTER TABLE REMOVE PARTITIONING
|
else:
|
||||||
return
|
self.check_housekeeper_execution()
|
||||||
|
|
||||||
for period, tables in partitions_conf.items():
|
for period, tables in partitions_conf.items():
|
||||||
if not tables:
|
if not tables:
|
||||||
@@ -534,12 +633,24 @@ class ZabbixPartitioner:
|
|||||||
table = list(item.keys())[0]
|
table = list(item.keys())[0]
|
||||||
retention = item[table]
|
retention = item[table]
|
||||||
|
|
||||||
|
if not self.validate_table_exists(table):
|
||||||
|
continue
|
||||||
|
|
||||||
if mode == 'init':
|
if mode == 'init':
|
||||||
self.initialize_partitioning(table, period, premake, retention)
|
try:
|
||||||
|
if self.fast_init:
|
||||||
|
self.initialize_partitioning_fast(table, period, premake, retention)
|
||||||
|
else:
|
||||||
|
self.initialize_partitioning_scan(table, period, premake)
|
||||||
|
except ConfigurationError as e:
|
||||||
|
raise ConfigurationError(f"Table '{table}': {e}")
|
||||||
else:
|
else:
|
||||||
# Maintenance mode (Add new, remove old)
|
# Maintenance mode (Add new, remove old)
|
||||||
|
try:
|
||||||
self.create_future_partitions(table, period, premake)
|
self.create_future_partitions(table, period, premake)
|
||||||
self.remove_old_partitions(table, retention)
|
self.remove_old_partitions(table, retention)
|
||||||
|
except ConfigurationError as e:
|
||||||
|
raise ConfigurationError(f"Table '{table}': {e}")
|
||||||
|
|
||||||
# Housekeeping extras
|
# Housekeeping extras
|
||||||
if mode != 'init' and not self.dry_run:
|
if mode != 'init' and not self.dry_run:
|
||||||
@@ -548,9 +659,149 @@ class ZabbixPartitioner:
|
|||||||
if mode != 'init' and not self.dry_run:
|
if mode != 'init' and not self.dry_run:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
def setup_logging(config_log_type: str):
|
def get_retention_input(prompt: str, default: str = None, allow_empty: bool = False) -> str:
|
||||||
|
"""Helper to get and validate retention period input."""
|
||||||
|
while True:
|
||||||
|
val = input(prompt).strip()
|
||||||
|
|
||||||
|
# Handle Empty Input
|
||||||
|
if not val:
|
||||||
|
if default:
|
||||||
|
return default
|
||||||
|
if allow_empty:
|
||||||
|
return ""
|
||||||
|
# If no default and not allow_empty, continue loop
|
||||||
|
continue
|
||||||
|
|
||||||
|
# Handle Unit-less Input (Reject)
|
||||||
|
if val.isdigit():
|
||||||
|
print(f"Error: '{val}' is missing a unit. Please use 'd', 'w', 'm', or 'y' (e.g., {val}d).")
|
||||||
|
continue
|
||||||
|
|
||||||
|
# Validate Format
|
||||||
|
if re.search(PART_PERIOD_REGEX, val):
|
||||||
|
return val
|
||||||
|
|
||||||
|
print("Invalid format. Use format like 30d, 12w, 1y.")
|
||||||
|
|
||||||
|
def run_wizard():
|
||||||
|
print("Welcome to Zabbix Partitioning Wizard")
|
||||||
|
print("-------------------------------------")
|
||||||
|
|
||||||
|
config = {
|
||||||
|
'database': {'type': 'mysql'},
|
||||||
|
'partitions': {'daily': [], 'weekly': [], 'monthly': []},
|
||||||
|
'logging': 'console',
|
||||||
|
'premake': 10,
|
||||||
|
'replicate_sql': False
|
||||||
|
}
|
||||||
|
|
||||||
|
# 1. Connection
|
||||||
|
print("\n[Database Connection]")
|
||||||
|
use_socket = input("Use Socket (s) or Address (a)? [s/a]: ").lower().strip() == 's'
|
||||||
|
if use_socket:
|
||||||
|
sock = input("Socket path [/var/run/mysqld/mysqld.sock]: ").strip() or '/var/run/mysqld/mysqld.sock'
|
||||||
|
config['database']['socket'] = sock
|
||||||
|
config['database']['host'] = 'localhost' # Fallback
|
||||||
|
config['database']['port'] = 3306
|
||||||
|
else:
|
||||||
|
host = input("Database Host [localhost]: ").strip() or 'localhost'
|
||||||
|
port_str = input("Database Port [3306]: ").strip() or '3306'
|
||||||
|
config['database']['host'] = host
|
||||||
|
config['database']['port'] = int(port_str)
|
||||||
|
|
||||||
|
config['database']['user'] = input("Database User [zabbix]: ").strip() or 'zabbix'
|
||||||
|
config['database']['passwd'] = input("Database Password: ").strip()
|
||||||
|
config['database']['db'] = input("Database Name [zabbix]: ").strip() or 'zabbix'
|
||||||
|
|
||||||
|
# 1.1 SSL
|
||||||
|
if input("Use SSL/TLS for connection? [y/N]: ").lower().strip() == 'y':
|
||||||
|
print(" Mode 1: Managed/Cloud DB (Use system CAs, e.g. Azure/AWS)")
|
||||||
|
print(" Mode 2: Custom Certificates (Provide ca, cert, key)")
|
||||||
|
|
||||||
|
if input(" Use custom certificates? [y/N]: ").lower().strip() == 'y':
|
||||||
|
ssl_conf = {}
|
||||||
|
ssl_conf['ca'] = input(" CA Certificate Path: ").strip()
|
||||||
|
ssl_conf['cert'] = input(" Client Certificate Path: ").strip()
|
||||||
|
ssl_conf['key'] = input(" Client Key Path: ").strip()
|
||||||
|
# Filter empty
|
||||||
|
config['database']['ssl'] = {k: v for k, v in ssl_conf.items() if v}
|
||||||
|
else:
|
||||||
|
config['database']['ssl'] = 'required'
|
||||||
|
|
||||||
|
# 2. Auditlog
|
||||||
|
print("\n[Auditlog]")
|
||||||
|
print("Note: To partition 'auditlog', ensure its Primary Key includes the 'clock' column.")
|
||||||
|
if input("Partition 'auditlog' table? [y/N]: ").lower().strip() == 'y':
|
||||||
|
ret = get_retention_input("Auditlog retention (e.g. 365d) [365d]: ", "365d")
|
||||||
|
config['partitions']['weekly'].append({'auditlog': ret})
|
||||||
|
|
||||||
|
# 3. History Tables
|
||||||
|
# History tables list
|
||||||
|
history_tables = ['history', 'history_uint', 'history_str', 'history_log', 'history_text', 'history_bin']
|
||||||
|
|
||||||
|
print("\n[History Tables]")
|
||||||
|
# Separate logic as requested
|
||||||
|
if input("Set SAME retention for all history tables? [Y/n]: ").lower().strip() != 'n':
|
||||||
|
ret = get_retention_input("Retention for all history tables (e.g. 30d) [30d]: ", "30d")
|
||||||
|
for t in history_tables:
|
||||||
|
config['partitions']['daily'].append({t: ret})
|
||||||
|
else:
|
||||||
|
for t in history_tables:
|
||||||
|
ret = get_retention_input(f"Retention for '{t}' (e.g. 30d, skip to ignore): ", allow_empty=True)
|
||||||
|
if ret:
|
||||||
|
config['partitions']['daily'].append({t: ret})
|
||||||
|
|
||||||
|
# 4. Trends Tables
|
||||||
|
trends_tables = ['trends', 'trends_uint']
|
||||||
|
print("\n[Trends Tables]")
|
||||||
|
if input("Set SAME retention for all trends tables? [Y/n]: ").lower().strip() != 'n':
|
||||||
|
ret = get_retention_input("Retention for all trends tables (e.g. 365d) [365d]: ", "365d")
|
||||||
|
for t in trends_tables:
|
||||||
|
config['partitions']['monthly'].append({t: ret})
|
||||||
|
else:
|
||||||
|
for t in trends_tables:
|
||||||
|
ret = get_retention_input(f"Retention for '{t}' (e.g. 365d, skip to ignore): ", allow_empty=True)
|
||||||
|
if ret:
|
||||||
|
config['partitions']['monthly'].append({t: ret})
|
||||||
|
|
||||||
|
# 5. Replication
|
||||||
|
print("\n[Replication]")
|
||||||
|
config['replicate_sql'] = input("Enable binary logging for replication? [y/N]: ").lower().strip() == 'y'
|
||||||
|
|
||||||
|
# 6. Premake
|
||||||
|
print("\n[Premake]")
|
||||||
|
pm = input("How many future partitions to create? [10]: ").strip()
|
||||||
|
config['premake'] = int(pm) if pm.isdigit() else 10
|
||||||
|
|
||||||
|
# 7. Logging
|
||||||
|
print("\n[Logging]")
|
||||||
|
config['logging'] = 'syslog' if input("Log to syslog? [y/N]: ").lower().strip() == 'y' else 'console'
|
||||||
|
|
||||||
|
# Save
|
||||||
|
print("\n[Output]")
|
||||||
|
path = input("Save config to [/etc/zabbix/zabbix_partitioning.conf]: ").strip() or '/etc/zabbix/zabbix_partitioning.conf'
|
||||||
|
|
||||||
|
try:
|
||||||
|
# Create dir if not exists
|
||||||
|
folder = os.path.dirname(path)
|
||||||
|
if folder and not os.path.exists(folder):
|
||||||
|
try:
|
||||||
|
os.makedirs(folder)
|
||||||
|
except OSError:
|
||||||
|
print(f"Warning: Could not create directory {folder}. Saving to current directory.")
|
||||||
|
path = 'zabbix_partitioning.conf'
|
||||||
|
|
||||||
|
with open(path, 'w') as f:
|
||||||
|
yaml.dump(config, f, default_flow_style=False)
|
||||||
|
print(f"\nConfiguration saved to {path}")
|
||||||
|
except Exception as e:
|
||||||
|
print(f"Error saving config: {e}")
|
||||||
|
print(yaml.dump(config)) # dump to stdout if fails
|
||||||
|
|
||||||
|
def setup_logging(config_log_type: str, verbose: bool = False):
|
||||||
logger = logging.getLogger('zabbix_partitioning')
|
logger = logging.getLogger('zabbix_partitioning')
|
||||||
logger.setLevel(logging.DEBUG)
|
logger.setLevel(logging.DEBUG if verbose else logging.INFO)
|
||||||
|
|
||||||
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
|
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
|
||||||
|
|
||||||
@@ -564,15 +815,43 @@ def setup_logging(config_log_type: str):
|
|||||||
logger.addHandler(handler)
|
logger.addHandler(handler)
|
||||||
|
|
||||||
def parse_args():
|
def parse_args():
|
||||||
parser = argparse.ArgumentParser(description='Zabbix Partitioning Manager')
|
parser = argparse.ArgumentParser(
|
||||||
parser.add_argument('-c', '--config', default='/etc/zabbix/zabbix_partitioning.conf', help='Config file path')
|
description='Zabbix Database Partitioning Script',
|
||||||
parser.add_argument('-i', '--init', action='store_true', help='Initialize partitions')
|
epilog='''
|
||||||
parser.add_argument('-d', '--delete', action='store_true', help='Remove partitions (Not implemented)')
|
Examples:
|
||||||
parser.add_argument('--dry-run', action='store_true', help='Simulate queries')
|
# 1. Interactive Configuration (Initial config file creation)
|
||||||
|
%(prog)s --wizard
|
||||||
|
|
||||||
# Monitoring args
|
# 2. Initialization (First Run)
|
||||||
parser.add_argument('--discovery', action='store_true', help='Output Zabbix LLD JSON')
|
# A. Standard (Scans DB for oldest record - Recommended):
|
||||||
parser.add_argument('--check-days', type=str, help='Check days of future partitions left for table', metavar='TABLE')
|
%(prog)s --init
|
||||||
|
|
||||||
|
# B. Fast (Start from retention period - Best for large DBs):
|
||||||
|
%(prog)s --fast-init
|
||||||
|
|
||||||
|
# 3. Regular Maintenance (Cron/Systemd)
|
||||||
|
# Creates future partitions and drops old ones.
|
||||||
|
%(prog)s
|
||||||
|
|
||||||
|
# 4. Monitoring (Zabbix Integration)
|
||||||
|
# Discovery (LLD): %(prog)s --discovery
|
||||||
|
# Statistics (JSON): %(prog)s --stats history
|
||||||
|
''',
|
||||||
|
formatter_class=argparse.RawDescriptionHelpFormatter
|
||||||
|
)
|
||||||
|
parser.add_argument('--config','-c', default='/etc/zabbix/zabbix_partitioning.conf', help='Path to configuration file')
|
||||||
|
|
||||||
|
# Mutually Exclusive Actions
|
||||||
|
group = parser.add_mutually_exclusive_group()
|
||||||
|
group.add_argument('--init', '-i', action='store_true', help='Initialize partitions (Standard: Scans DB for oldest record)')
|
||||||
|
group.add_argument('--fast-init', '-f', action='store_true', help='Initialize partitions (Fast: Starts FROM retention period, skips scan)')
|
||||||
|
group.add_argument('--discovery', '-d', action='store_true', help='Output Zabbix Low-Level Discovery (LLD) JSON')
|
||||||
|
group.add_argument('--stats', '-s', type=str, help='Output table statistics (Size, Count, Usage) in JSON', metavar='TABLE')
|
||||||
|
group.add_argument('--wizard', '-w', action='store_true', help='Launch interactive configuration wizard')
|
||||||
|
|
||||||
|
parser.add_argument('--version', '-V', action='version', version=f'%(prog)s {VERSION}', help='Show version and exit')
|
||||||
|
parser.add_argument('--verbose', '-vv', action='store_true', help='Enable debug logging')
|
||||||
|
parser.add_argument('--dry-run', '-r', action='store_true', help='Simulate queries without executing them')
|
||||||
|
|
||||||
return parser.parse_args()
|
return parser.parse_args()
|
||||||
|
|
||||||
@@ -588,6 +867,10 @@ def main():
|
|||||||
args = parse_args()
|
args = parse_args()
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
if args.wizard:
|
||||||
|
run_wizard()
|
||||||
|
return
|
||||||
|
|
||||||
conf_path = load_config(args.config)
|
conf_path = load_config(args.config)
|
||||||
with open(conf_path, 'r') as f:
|
with open(conf_path, 'r') as f:
|
||||||
config = yaml.safe_load(f)
|
config = yaml.safe_load(f)
|
||||||
@@ -603,19 +886,19 @@ def main():
|
|||||||
config['logging'] = 'console' # Force console for discovery? Or suppress?
|
config['logging'] = 'console' # Force console for discovery? Or suppress?
|
||||||
# actually we don't want logs mixing with JSON output
|
# actually we don't want logs mixing with JSON output
|
||||||
# so checking mode before setup logging
|
# so checking mode before setup logging
|
||||||
elif args.check_days:
|
elif args.stats:
|
||||||
mode = 'check'
|
mode = 'stats'
|
||||||
target = args.check_days
|
target = args.stats
|
||||||
elif args.init: mode = 'init'
|
elif args.init:
|
||||||
elif args.delete: mode = 'delete'
|
mode = 'init'
|
||||||
|
elif args.fast_init:
|
||||||
|
mode = 'init'
|
||||||
|
|
||||||
# Setup logging
|
# Setup logging
|
||||||
# If discovery or check, we mute info logs to stdout to keep output clean,
|
if mode in ['discovery', 'stats']:
|
||||||
# unless errors happen.
|
|
||||||
if mode in ['discovery', 'check']:
|
|
||||||
logging.basicConfig(level=logging.ERROR) # Only show critical errors
|
logging.basicConfig(level=logging.ERROR) # Only show critical errors
|
||||||
else:
|
else:
|
||||||
setup_logging(config.get('logging', 'console'))
|
setup_logging(config.get('logging', 'console'), verbose=args.verbose)
|
||||||
|
|
||||||
logger = logging.getLogger('zabbix_partitioning')
|
logger = logging.getLogger('zabbix_partitioning')
|
||||||
|
|
||||||
@@ -623,7 +906,7 @@ def main():
|
|||||||
logger.info("Starting in DRY-RUN mode")
|
logger.info("Starting in DRY-RUN mode")
|
||||||
|
|
||||||
# ZabbixPartitioner expects dict config
|
# ZabbixPartitioner expects dict config
|
||||||
app = ZabbixPartitioner(config, dry_run=args.dry_run)
|
app = ZabbixPartitioner(config, dry_run=args.dry_run, fast_init=args.fast_init)
|
||||||
app.run(mode, target)
|
app.run(mode, target)
|
||||||
|
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
|
|||||||
129
partitioning/zabbix_mysql_partitioning_template.yaml
Normal file
129
partitioning/zabbix_mysql_partitioning_template.yaml
Normal file
@@ -0,0 +1,129 @@
|
|||||||
|
zabbix_export:
|
||||||
|
version: '7.0'
|
||||||
|
template_groups:
|
||||||
|
- uuid: e29f7cbf75cf41cb81078cb4c10d584a
|
||||||
|
name: Templates/Databases
|
||||||
|
templates:
|
||||||
|
- uuid: 69899eb3126b4c62b70351f305b69dd9
|
||||||
|
template: 'Zabbix Partitioning Monitor'
|
||||||
|
name: 'Zabbix Partitioning Monitor'
|
||||||
|
description: |
|
||||||
|
Monitor Zabbix Database Partitioning.
|
||||||
|
Prerequisites:
|
||||||
|
1. Install zabbix_partitioning.py on the Zabbix Server/Proxy.
|
||||||
|
2. Configure userparameter for automatic discovery:
|
||||||
|
UserParameter=zabbix.partitioning.discovery[*], /usr/local/bin/zabbix_partitioning.py -c $1 --discovery
|
||||||
|
UserParameter=zabbix.partitioning.discovery[*], /usr/local/bin/zabbix_partitioning.py -c $1 --discovery
|
||||||
|
UserParameter=zabbix.partitioning.stats[*], /usr/local/bin/zabbix_partitioning.py -c $1 --stats $2
|
||||||
|
# Legacy check removed in favor of stats
|
||||||
|
|
||||||
|
Or use Docker wrapper scripts.
|
||||||
|
groups:
|
||||||
|
- name: Templates/Databases
|
||||||
|
items:
|
||||||
|
- uuid: bc753e750cc2485f917ba1f023c87d05
|
||||||
|
name: 'Partitioning Last Run Status'
|
||||||
|
type: ZABBIX_ACTIVE
|
||||||
|
key: 'log[/var/log/syslog,zabbix_partitioning]'
|
||||||
|
history: 7d
|
||||||
|
value_type: LOG
|
||||||
|
trends: '0'
|
||||||
|
triggers:
|
||||||
|
- uuid: 25497978dbb943e49dac8f3b9db91c29
|
||||||
|
expression: 'find(/Zabbix Partitioning Monitor/log[/var/log/syslog,zabbix_partitioning],,"like","Failed")=1'
|
||||||
|
name: 'Partitioning Script Failed'
|
||||||
|
priority: HIGH
|
||||||
|
description: 'The partitioning script reported a failure.'
|
||||||
|
tags:
|
||||||
|
- tag: services
|
||||||
|
value: database
|
||||||
|
discovery_rules:
|
||||||
|
- uuid: 097c96467035468a80ce5c519b0297bb
|
||||||
|
name: 'Partitioning Discovery'
|
||||||
|
key: 'zabbix.partitioning.discovery[{$PATH.TO.CONFIG}]'
|
||||||
|
delay: 1d
|
||||||
|
description: 'Discover partitioned tables'
|
||||||
|
item_prototypes:
|
||||||
|
- uuid: 1fbff85191c244dca956be7a94bf08a3
|
||||||
|
name: 'Partitioning Stats: {#TABLE}'
|
||||||
|
key: 'zabbix.partitioning.stats[{$PATH.TO.CONFIG}, {#TABLE}]'
|
||||||
|
delay: 12h
|
||||||
|
history: '0'
|
||||||
|
trends: '0'
|
||||||
|
value_type: TEXT
|
||||||
|
description: 'JSON statistics for table {#TABLE}'
|
||||||
|
tags:
|
||||||
|
- tag: component
|
||||||
|
value: partitioning
|
||||||
|
- tag: table
|
||||||
|
value: '{#TABLE}'
|
||||||
|
|
||||||
|
- uuid: a8371234567890abcdef1234567890ab
|
||||||
|
name: 'Days remaining: {#TABLE}'
|
||||||
|
type: DEPENDENT
|
||||||
|
key: 'zabbix.partitioning.days_left[{#TABLE}]'
|
||||||
|
delay: 0
|
||||||
|
history: 7d
|
||||||
|
description: 'Days until the last partition runs out for {#TABLE}'
|
||||||
|
master_item:
|
||||||
|
key: 'zabbix.partitioning.stats[{$PATH.TO.CONFIG}, {#TABLE}]'
|
||||||
|
preprocessing:
|
||||||
|
- type: JSONPATH
|
||||||
|
parameters:
|
||||||
|
- $.days_left
|
||||||
|
tags:
|
||||||
|
- tag: component
|
||||||
|
value: partitioning
|
||||||
|
- tag: table
|
||||||
|
value: '{#TABLE}'
|
||||||
|
trigger_prototypes:
|
||||||
|
- uuid: da23fae76a41455c86c58267d6d9f86d
|
||||||
|
expression: 'last(/Zabbix Partitioning Monitor/zabbix.partitioning.days_left[{#TABLE}])<={$PARTITION.DAYS}'
|
||||||
|
name: 'Partitioning critical: {#TABLE} has less than {$PARTITION.DAYS} days in partition'
|
||||||
|
opdata: 'Days till Zabbix server will crash: {ITEM.LASTVALUE}'
|
||||||
|
priority: DISASTER
|
||||||
|
description: 'New partitions are not being created. Check the script logs.'
|
||||||
|
|
||||||
|
- uuid: b9482345678901bcdef23456789012cd
|
||||||
|
name: 'Partition Count: {#TABLE}'
|
||||||
|
type: DEPENDENT
|
||||||
|
key: 'zabbix.partitioning.count[{#TABLE}]'
|
||||||
|
delay: 0
|
||||||
|
history: 7d
|
||||||
|
description: 'Total number of partitions for {#TABLE}'
|
||||||
|
master_item:
|
||||||
|
key: 'zabbix.partitioning.stats[{$PATH.TO.CONFIG}, {#TABLE}]'
|
||||||
|
preprocessing:
|
||||||
|
- type: JSONPATH
|
||||||
|
parameters:
|
||||||
|
- $.partition_count
|
||||||
|
tags:
|
||||||
|
- tag: component
|
||||||
|
value: partitioning
|
||||||
|
- tag: table
|
||||||
|
value: '{#TABLE}'
|
||||||
|
|
||||||
|
- uuid: c0593456789012cdef345678901234de
|
||||||
|
name: 'Table Size: {#TABLE}'
|
||||||
|
type: DEPENDENT
|
||||||
|
key: 'zabbix.partitioning.size[{#TABLE}]'
|
||||||
|
delay: 0
|
||||||
|
history: 7d
|
||||||
|
units: B
|
||||||
|
description: 'Total size (Data+Index) of {#TABLE}'
|
||||||
|
master_item:
|
||||||
|
key: 'zabbix.partitioning.stats[{$PATH.TO.CONFIG}, {#TABLE}]'
|
||||||
|
preprocessing:
|
||||||
|
- type: JSONPATH
|
||||||
|
parameters:
|
||||||
|
- $.size_bytes
|
||||||
|
tags:
|
||||||
|
- tag: component
|
||||||
|
value: partitioning
|
||||||
|
- tag: table
|
||||||
|
value: '{#TABLE}'
|
||||||
|
macros:
|
||||||
|
- macro: '{$PARTITION.DAYS}'
|
||||||
|
value: '3'
|
||||||
|
- macro: '{$PATH.TO.CONFIG}'
|
||||||
|
value: /etc/zabbix/scripts/zabbix_partitioning.conf
|
||||||
@@ -1,65 +0,0 @@
|
|||||||
zabbix_export:
|
|
||||||
version: '7.0'
|
|
||||||
template_groups:
|
|
||||||
- uuid: e29f7cbf75cf41cb81078cb4c10d584a
|
|
||||||
name: 'Templates/Databases'
|
|
||||||
templates:
|
|
||||||
- uuid: 69899eb3126b4c62b70351f305b69dd9
|
|
||||||
template: 'Zabbix Partitioning Monitor'
|
|
||||||
name: 'Zabbix Partitioning Monitor'
|
|
||||||
description: |
|
|
||||||
Monitor Zabbix Database Partitioning.
|
|
||||||
Prerequisites:
|
|
||||||
1. Install zabbix_partitioning.py on the Zabbix Server/Proxy.
|
|
||||||
2. Configure userparameter for automatic discovery:
|
|
||||||
UserParameter=zabbix.partitioning.discovery[*], /usr/local/bin/zabbix_partitioning.py -c $1 --discovery
|
|
||||||
UserParameter=zabbix.partitioning.check[*], /usr/local/bin/zabbix_partitioning.py -c $1 --check-days $2
|
|
||||||
|
|
||||||
Or use Docker wrapper scripts.
|
|
||||||
|
|
||||||
groups:
|
|
||||||
- name: 'Templates/Databases'
|
|
||||||
items:
|
|
||||||
- uuid: bc753e750cc2485f917ba1f023c87d05
|
|
||||||
name: 'Partitioning Last Run Status'
|
|
||||||
type: TRAP
|
|
||||||
key: partitioning.run.status
|
|
||||||
delay: 0
|
|
||||||
history: 7d
|
|
||||||
trends: '0'
|
|
||||||
value_type: TEXT
|
|
||||||
description: 'Send "Success" or "Failed" via zabbix_sender or check log file'
|
|
||||||
triggers:
|
|
||||||
- uuid: 25497978dbb943e49dac8f3b9db91c29
|
|
||||||
expression: 'find(/Zabbix Partitioning Monitor/partitioning.run.status,,"like","Failed")=1'
|
|
||||||
name: 'Zabbix Partitioning Failed'
|
|
||||||
priority: HIGH
|
|
||||||
description: 'The partitioning script reported a failure.'
|
|
||||||
tags:
|
|
||||||
- tag: services
|
|
||||||
value: database
|
|
||||||
|
|
||||||
discovery_rules:
|
|
||||||
- uuid: 097c96467035468a80ce5c519b0297bb
|
|
||||||
name: 'Partitioning Discovery'
|
|
||||||
key: 'zabbix.partitioning.discovery[/etc/zabbix/zabbix_partitioning.conf]'
|
|
||||||
delay: 1h
|
|
||||||
description: 'Discover partitioned tables'
|
|
||||||
item_prototypes:
|
|
||||||
- uuid: 1fbff85191c244dca956be7a94bf08a3
|
|
||||||
name: 'Partitions remaining: {#TABLE}'
|
|
||||||
key: 'zabbix.partitioning.check[/etc/zabbix/zabbix_partitioning.conf, {#TABLE}]'
|
|
||||||
delay: 12h
|
|
||||||
history: 7d
|
|
||||||
description: 'Days until the last partition runs out for {#TABLE}'
|
|
||||||
tags:
|
|
||||||
- tag: component
|
|
||||||
value: partitioning
|
|
||||||
- tag: table
|
|
||||||
value: '{#TABLE}'
|
|
||||||
trigger_prototypes:
|
|
||||||
- uuid: da23fae76a41455c86c58267d6d9f86d
|
|
||||||
expression: 'last(/Zabbix Partitioning Monitor/zabbix.partitioning.check[/etc/zabbix/zabbix_partitioning.conf, {#TABLE}])<=3'
|
|
||||||
name: 'Partitioning critical: {#TABLE} has less than 3 days of partitions'
|
|
||||||
priority: HIGH
|
|
||||||
description: 'New partitions are not being created. Check the script logs.'
|
|
||||||
Reference in New Issue
Block a user