Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
5d96c6fbae
|
|||
|
badee2c598
|
|||
|
6112a707c7
|
|||
| 956755fe82 | |||
| 44ab702369 |
675
LICENSE
Normal file
675
LICENSE
Normal file
@@ -0,0 +1,675 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
|
||||
138
README.md
138
README.md
@@ -1,2 +1,138 @@
|
||||
# ScuroLogger (slog)
|
||||
# slog
|
||||
|
||||
Small structured logger for Go with text and JSON output, multiple writers, and optional traceback metadata.
|
||||
|
||||
Russian version: [README_ru.md](README_ru.md)
|
||||
|
||||
## Features
|
||||
|
||||
- Fan out the same record to multiple destinations.
|
||||
- Text and JSON writers.
|
||||
- `stdout`, files, and arbitrary external `io.Writer` values.
|
||||
- Optional timestamps for text output.
|
||||
- Compact traceback metadata for text writers and full traceback slices for JSON.
|
||||
- Explicit ownership rules for writer closing.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
go get git.nix13.pw/scuroneko/slog
|
||||
```
|
||||
|
||||
## Quick start
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"log"
|
||||
|
||||
"git.nix13.pw/scuroneko/slog"
|
||||
)
|
||||
|
||||
func main() {
|
||||
logger := slog.CreateLogger().
|
||||
Prefix("API").
|
||||
Level(slog.DEBUG).
|
||||
PrintTraceback(true).
|
||||
JsonPretty(true)
|
||||
|
||||
text := logger.CreateTextStdoutWriter()
|
||||
jsonFile, err := logger.CreateJsonFileWriter("logs/app.json")
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
logger.AddWriters(text, jsonFile)
|
||||
|
||||
logger.Infoln("service started")
|
||||
logger.Warnln("cache miss")
|
||||
logger.Errorln("request failed")
|
||||
logger.Debugln("debug details")
|
||||
|
||||
if err := logger.Close(); err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Defaults
|
||||
|
||||
`CreateLogger()` starts with:
|
||||
|
||||
- `Prefix("LOG")`
|
||||
- `Level(slog.FATAL)`
|
||||
- `PrintTime(true)`
|
||||
- `PrintTraceback(false)`
|
||||
- `JsonPretty(false)`
|
||||
|
||||
Important: with the current level ordering, `Level(slog.FATAL)` allows `INFO`, `WARN`, `ERROR`, and `FATAL`, but not `DEBUG`. Use `Level(slog.DEBUG)` to enable every level.
|
||||
|
||||
## Writers and ownership
|
||||
|
||||
`Logger.Close()` only closes writers created by the logger itself:
|
||||
|
||||
- `CreateTextFileWriter(...)`
|
||||
- `CreateJsonFileWriter(...)`
|
||||
|
||||
The following writers remain owned by the caller and are not closed by `Logger.Close()`:
|
||||
|
||||
- `CreateTextWriter(existingWriter)`
|
||||
- `CreateJsonWriter(existingWriter)`
|
||||
- `CreateTextStdoutWriter()`
|
||||
- `CreateJsonStdoutWriter()`
|
||||
|
||||
This makes it safe to plug in `bytes.Buffer`, network writers, and other externally managed resources.
|
||||
|
||||
## Output formats
|
||||
|
||||
Text writers render records like:
|
||||
|
||||
```text
|
||||
[API] [INFO] [main.go:main:27] [17.03.26 14:05:09] service started
|
||||
```
|
||||
|
||||
The traceback field is included only when `PrintTraceback(true)` is enabled.
|
||||
|
||||
JSON writers emit objects with this shape:
|
||||
|
||||
```json
|
||||
{
|
||||
"time": "2026-03-17T14:05:09.123456789+03:00",
|
||||
"level": "info",
|
||||
"prefix": "API",
|
||||
"message": "service started",
|
||||
"traceback": [
|
||||
{
|
||||
"method": "main",
|
||||
"filename": "main.go",
|
||||
"line": 27,
|
||||
"signature": "main.main",
|
||||
"fullPath": "/path/to/main.go"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
When `JsonPretty(true)` is enabled, JSON is indented.
|
||||
|
||||
## API summary
|
||||
|
||||
- `Info`, `Warn`, `Error`, `Debug`, and `Fatal` accept a list of values.
|
||||
- `Infof`, `Warnf`, `Errorf`, `Debugf`, and `Fatalf` use `fmt.Sprintf`.
|
||||
- The `*ln` methods preserve newline semantics, which is useful for `stdout`, Docker, and line-based collectors.
|
||||
- `Fatal`, `Fatalf`, and `Fatalln` call `os.Exit(1)` after writing the message.
|
||||
|
||||
## Traceback behavior
|
||||
|
||||
- Text writers use the nearest user stack frame.
|
||||
- JSON writers receive the full traceback slice.
|
||||
- Internal `slog` frames and `runtime` frames are filtered out.
|
||||
|
||||
## Repository example
|
||||
|
||||
See [examples/main.go](examples/main.go).
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under GNU GPLv3. See [LICENSE](LICENSE).
|
||||
|
||||
138
README_ru.md
Normal file
138
README_ru.md
Normal file
@@ -0,0 +1,138 @@
|
||||
# slog
|
||||
|
||||
Небольшой структурированный логгер для Go с текстовым и JSON-выводом, несколькими writer'ами и настраиваемыми traceback-метаданными.
|
||||
|
||||
English version: [README.md](README.md)
|
||||
|
||||
## Возможности
|
||||
|
||||
- Одновременная запись в несколько destinations.
|
||||
- Текстовый и JSON-форматы.
|
||||
- `stdout`, файлы и любые внешние `io.Writer`.
|
||||
- Опциональные timestamp'ы для текстового вывода.
|
||||
- Компактный traceback для текстовых writer'ов и полный traceback для JSON.
|
||||
- Явные правила владения writer'ами при `Close()`.
|
||||
|
||||
## Установка
|
||||
|
||||
```bash
|
||||
go get git.nix13.pw/scuroneko/slog
|
||||
```
|
||||
|
||||
## Быстрый старт
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"log"
|
||||
|
||||
"git.nix13.pw/scuroneko/slog"
|
||||
)
|
||||
|
||||
func main() {
|
||||
logger := slog.CreateLogger().
|
||||
Prefix("API").
|
||||
Level(slog.DEBUG).
|
||||
PrintTraceback(true).
|
||||
JsonPretty(true)
|
||||
|
||||
text := logger.CreateTextStdoutWriter()
|
||||
jsonFile, err := logger.CreateJsonFileWriter("logs/app.json")
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
logger.AddWriters(text, jsonFile)
|
||||
|
||||
logger.Infoln("service started")
|
||||
logger.Warnln("cache miss")
|
||||
logger.Errorln("request failed")
|
||||
logger.Debugln("debug details")
|
||||
|
||||
if err := logger.Close(); err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Значения по умолчанию
|
||||
|
||||
`CreateLogger()` создает логгер со следующими настройками:
|
||||
|
||||
- `Prefix("LOG")`
|
||||
- `Level(slog.FATAL)`
|
||||
- `PrintTime(true)`
|
||||
- `PrintTraceback(false)`
|
||||
- `JsonPretty(false)`
|
||||
|
||||
Важно: в текущей модели уровней `Level(slog.FATAL)` пропускает `INFO`, `WARN`, `ERROR` и `FATAL`, но не `DEBUG`. Чтобы включить все сообщения, используйте `Level(slog.DEBUG)`.
|
||||
|
||||
## Writer'ы и владение
|
||||
|
||||
`Logger.Close()` закрывает только writer'ы, которые логгер создал сам:
|
||||
|
||||
- `CreateTextFileWriter(...)`
|
||||
- `CreateJsonFileWriter(...)`
|
||||
|
||||
Внешние writer'ы не закрываются:
|
||||
|
||||
- `CreateTextWriter(existingWriter)`
|
||||
- `CreateJsonWriter(existingWriter)`
|
||||
- `CreateTextStdoutWriter()`
|
||||
- `CreateJsonStdoutWriter()`
|
||||
|
||||
Это позволяет безопасно подключать `bytes.Buffer`, сетевые writer'ы и другие уже управляемые ресурсы.
|
||||
|
||||
## Форматы вывода
|
||||
|
||||
Текстовый writer формирует записи вида:
|
||||
|
||||
```text
|
||||
[API] [INFO] [main.go:main:27] [17.03.26 14:05:09] service started
|
||||
```
|
||||
|
||||
Поле traceback появляется только если включен `PrintTraceback(true)`.
|
||||
|
||||
JSON writer записывает объект со следующими полями:
|
||||
|
||||
```json
|
||||
{
|
||||
"time": "2026-03-17T14:05:09.123456789+03:00",
|
||||
"level": "info",
|
||||
"prefix": "API",
|
||||
"message": "service started",
|
||||
"traceback": [
|
||||
{
|
||||
"method": "main",
|
||||
"filename": "main.go",
|
||||
"line": 27,
|
||||
"signature": "main.main",
|
||||
"fullPath": "/path/to/main.go"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Если включен `JsonPretty(true)`, JSON выводится с отступами.
|
||||
|
||||
## API кратко
|
||||
|
||||
- `Info`, `Warn`, `Error`, `Debug`, `Fatal` принимают список значений.
|
||||
- `Infof`, `Warnf`, `Errorf`, `Debugf`, `Fatalf` используют `fmt.Sprintf`.
|
||||
- Методы `*ln` добавляют семантику перевода строки, что удобно для `stdout`, Docker и line-based collectors.
|
||||
- `Fatal`, `Fatalf` и `Fatalln` вызывают `os.Exit(1)` после записи сообщения.
|
||||
|
||||
## Поведение traceback
|
||||
|
||||
- Текстовые writer'ы используют ближайший пользовательский stack frame.
|
||||
- JSON writer'ы получают полный traceback.
|
||||
- Внутренние frame'ы `slog` и `runtime` фильтруются из traceback.
|
||||
|
||||
## Пример из репозитория
|
||||
|
||||
См. [examples/main.go](examples/main.go).
|
||||
|
||||
## Лицензия
|
||||
|
||||
Проект распространяется под GNU GPLv3. См. [LICENSE](LICENSE).
|
||||
42
doc.go
Normal file
42
doc.go
Normal file
@@ -0,0 +1,42 @@
|
||||
// Package slog provides a small structured logger that can write the same
|
||||
// record to text and JSON outputs.
|
||||
//
|
||||
// A Logger can fan out records to stdout, files, or any external io.Writer.
|
||||
// Text writers can include timestamps and a compact traceback frame. JSON
|
||||
// writers always emit a structured traceback slice.
|
||||
//
|
||||
// CreateLogger uses the following defaults:
|
||||
// - prefix: "LOG"
|
||||
// - level: FATAL, which enables info, warn, error, and fatal records
|
||||
// - text timestamps: enabled
|
||||
// - text traceback: disabled
|
||||
// - pretty JSON: disabled
|
||||
//
|
||||
// Call Level(DEBUG) to enable all records, including debug messages.
|
||||
//
|
||||
// Basic usage:
|
||||
//
|
||||
// logger := slog.CreateLogger().
|
||||
// Prefix("API").
|
||||
// Level(slog.DEBUG).
|
||||
// PrintTraceback(true).
|
||||
// JsonPretty(true)
|
||||
//
|
||||
// text := logger.CreateTextStdoutWriter()
|
||||
// jsonFile, err := logger.CreateJsonFileWriter("logs/app.json")
|
||||
// if err != nil {
|
||||
// panic(err)
|
||||
// }
|
||||
//
|
||||
// logger.AddWriters(text, jsonFile)
|
||||
// logger.Infoln("service started")
|
||||
//
|
||||
// if err := logger.Close(); err != nil {
|
||||
// panic(err)
|
||||
// }
|
||||
//
|
||||
// Writers created with CreateTextFileWriter or CreateJsonFileWriter are owned by
|
||||
// the logger and are closed by Logger.Close. Writers created from existing
|
||||
// io.Writer values through CreateTextWriter or CreateJsonWriter remain owned by
|
||||
// the caller and are not closed by the logger.
|
||||
package slog
|
||||
@@ -1,21 +1,53 @@
|
||||
package main
|
||||
|
||||
import "git.nix13.pw/scuroneko/slog"
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
|
||||
"git.nix13.pw/scuroneko/slog"
|
||||
)
|
||||
|
||||
func main() {
|
||||
logger := slog.CreateLogger().JsonPretty(false)
|
||||
defer logger.Close()
|
||||
logger.AddWriter(logger.CreateTextStdoutWriter())
|
||||
f, err := logger.CreateJsonFileWriter("main.log")
|
||||
logger := slog.CreateLogger().
|
||||
Prefix("EXAMPLE").
|
||||
Level(slog.DEBUG).
|
||||
JsonPretty(true)
|
||||
|
||||
textStdout := logger.CreateTextStdoutWriter()
|
||||
jsonStdout := logger.CreateJsonStdoutWriter()
|
||||
|
||||
textFile, err := logger.CreateTextFileWriter("logs/text.log")
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
logger.AddWriter(f)
|
||||
logger.Infoln("Test")
|
||||
logger.Warnln("Test")
|
||||
logger.Errorln("Test")
|
||||
logger.Debugln("Test") // No output
|
||||
logger.Level(slog.DEBUG)
|
||||
logger.Debugln("Test") // Now we have output
|
||||
logger.Fatalln("Test") // Exit code 1
|
||||
|
||||
jsonFile, err := logger.CreateJsonFileWriter("logs/json.log")
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
var externalBuffer bytes.Buffer
|
||||
externalText := logger.CreateTextWriter(&externalBuffer)
|
||||
externalJSON := logger.CreateJsonWriter(&externalBuffer)
|
||||
|
||||
logger.AddWriters(
|
||||
textStdout,
|
||||
jsonStdout,
|
||||
textFile,
|
||||
jsonFile,
|
||||
externalText,
|
||||
externalJSON,
|
||||
)
|
||||
|
||||
logger.Infoln("service started")
|
||||
logger.Warnln("cache miss")
|
||||
logger.Errorln("request failed")
|
||||
logger.Debugln("debug details")
|
||||
|
||||
if err := logger.Close(); err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
fmt.Println("external buffer contents:")
|
||||
fmt.Println(externalBuffer.String())
|
||||
}
|
||||
|
||||
4
go.mod
4
go.mod
@@ -1,11 +1,11 @@
|
||||
module git.nix13.pw/scuroneko/slog
|
||||
|
||||
go 1.25
|
||||
go 1.26
|
||||
|
||||
require github.com/fatih/color v1.18.0
|
||||
|
||||
require (
|
||||
github.com/mattn/go-colorable v0.1.14 // indirect
|
||||
github.com/mattn/go-isatty v0.0.20 // indirect
|
||||
golang.org/x/sys v0.40.0 // indirect
|
||||
golang.org/x/sys v0.42.0 // indirect
|
||||
)
|
||||
|
||||
1
go.sum
1
go.sum
@@ -7,3 +7,4 @@ github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D
|
||||
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ=
|
||||
golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
||||
golang.org/x/sys v0.42.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||
|
||||
43
io.go
43
io.go
@@ -5,55 +5,70 @@ import (
|
||||
"os"
|
||||
)
|
||||
|
||||
// Infof logs a formatted info message.
|
||||
func (l *Logger) Infof(format string, args ...any) {
|
||||
l.print(INFO, fmt.Sprintf(format, args...))
|
||||
}
|
||||
// Info logs an info message.
|
||||
func (l *Logger) Info(m ...any) {
|
||||
l.print(INFO, m...)
|
||||
}
|
||||
// Infoln logs an info message and appends a newline semantic for writers that need it.
|
||||
func (l *Logger) Infoln(m ...any) {
|
||||
l.println(INFO, m...)
|
||||
}
|
||||
|
||||
// Warnf logs a formatted warning message.
|
||||
func (l *Logger) Warnf(format string, args ...any) {
|
||||
l.print(WARN, fmt.Sprintf(format, args...))
|
||||
}
|
||||
// Warn logs a warning message.
|
||||
func (l *Logger) Warn(m ...any) {
|
||||
l.print(WARN, m...)
|
||||
}
|
||||
// Warnln logs a warning message with newline semantic.
|
||||
func (l *Logger) Warnln(m ...any) {
|
||||
l.println(WARN, m...)
|
||||
}
|
||||
|
||||
// Errorf logs a formatted error message.
|
||||
func (l *Logger) Errorf(format string, args ...any) {
|
||||
l.print(ERROR, fmt.Sprintf(format, args...))
|
||||
}
|
||||
// Error logs an error message.
|
||||
func (l *Logger) Error(m ...any) {
|
||||
l.print(ERROR, m...)
|
||||
}
|
||||
// Errorln logs an error message with newline semantic.
|
||||
func (l *Logger) Errorln(m ...any) {
|
||||
l.println(ERROR, m...)
|
||||
}
|
||||
|
||||
// Fatalf logs a formatted fatal message and exits the process with code 1.
|
||||
func (l *Logger) Fatalf(format string, args ...any) {
|
||||
l.print(FATAL, fmt.Sprintf(format, args...))
|
||||
os.Exit(1)
|
||||
}
|
||||
// Fatal logs a fatal message and exits the process with code 1.
|
||||
func (l *Logger) Fatal(m ...any) {
|
||||
l.print(FATAL, m...)
|
||||
os.Exit(1)
|
||||
}
|
||||
// Fatalln logs a fatal message with newline semantic and exits the process with code 1.
|
||||
func (l *Logger) Fatalln(m ...any) {
|
||||
l.println(FATAL, m...)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// Debugf logs a formatted debug message.
|
||||
func (l *Logger) Debugf(format string, args ...any) {
|
||||
l.print(DEBUG, fmt.Sprintf(format, args...))
|
||||
}
|
||||
// Debug logs a debug message.
|
||||
func (l *Logger) Debug(m ...any) {
|
||||
l.print(DEBUG, m...)
|
||||
}
|
||||
// Debugln logs a debug message with newline semantic.
|
||||
func (l *Logger) Debugln(m ...any) {
|
||||
l.println(DEBUG, m...)
|
||||
}
|
||||
@@ -64,12 +79,18 @@ func (l *Logger) print(level LogLevel, m ...any) {
|
||||
if l.level.n < level.n {
|
||||
return
|
||||
}
|
||||
if len(l.writers) == 0 {
|
||||
return
|
||||
}
|
||||
|
||||
tb := getFullTraceback(0)
|
||||
for _, writer := range l.writers {
|
||||
if writer == nil {
|
||||
continue
|
||||
}
|
||||
err := writer.Print(level, l.prefix, tb, m...)
|
||||
if err != nil {
|
||||
l.Error(err)
|
||||
l.reportWriterError(err)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -80,12 +101,28 @@ func (l *Logger) println(level LogLevel, m ...any) {
|
||||
if l.level.n < level.n {
|
||||
return
|
||||
}
|
||||
if len(l.writers) == 0 {
|
||||
return
|
||||
}
|
||||
|
||||
tb := getFullTraceback(0)
|
||||
messages := append(append(make([]any, 0, len(m)+1), m...), "\n")
|
||||
for _, writer := range l.writers {
|
||||
err := writer.Print(level, l.prefix, tb, append(m, "\n")...)
|
||||
if writer == nil {
|
||||
continue
|
||||
}
|
||||
err := writer.Print(level, l.prefix, tb, messages...)
|
||||
if err != nil {
|
||||
l.Error(err)
|
||||
l.reportWriterError(err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// reportWriterError writes internal writer failures directly to stderr to avoid
|
||||
// re-entering the same logger path that just failed.
|
||||
func (l *Logger) reportWriterError(err error) {
|
||||
if err == nil {
|
||||
return
|
||||
}
|
||||
_, _ = fmt.Fprintf(os.Stderr, "[%s] logger writer error: %v\n", l.prefix, err)
|
||||
}
|
||||
|
||||
34
logger.go
34
logger.go
@@ -1,6 +1,7 @@
|
||||
package slog
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"strings"
|
||||
@@ -9,6 +10,7 @@ import (
|
||||
"github.com/fatih/color"
|
||||
)
|
||||
|
||||
// Logger routes log records to one or more configured writers.
|
||||
type Logger struct {
|
||||
prefix string
|
||||
level LogLevel
|
||||
@@ -19,16 +21,19 @@ type Logger struct {
|
||||
jsonPretty bool
|
||||
}
|
||||
|
||||
// LogLevel describes a logging severity.
|
||||
type LogLevel struct {
|
||||
n uint8
|
||||
t string
|
||||
c color.Attribute
|
||||
}
|
||||
|
||||
// GetName returns the lowercase textual representation of the level.
|
||||
func (l *LogLevel) GetName() string {
|
||||
return l.t
|
||||
}
|
||||
|
||||
// MethodTraceback describes a single stack frame attached to a log entry.
|
||||
type MethodTraceback struct {
|
||||
Method string `json:"method"`
|
||||
Filename string `json:"filename"`
|
||||
@@ -37,6 +42,7 @@ type MethodTraceback struct {
|
||||
FullPath string `json:"fullPath"`
|
||||
}
|
||||
|
||||
// Predefined log levels.
|
||||
var (
|
||||
INFO = LogLevel{n: 0, t: "info", c: color.FgWhite}
|
||||
WARN = LogLevel{n: 1, t: "warn", c: color.FgHiYellow}
|
||||
@@ -45,6 +51,7 @@ var (
|
||||
DEBUG = LogLevel{n: 4, t: "debug", c: color.FgGreen}
|
||||
)
|
||||
|
||||
// CreateLogger creates a logger with default settings.
|
||||
func CreateLogger() *Logger {
|
||||
return &Logger{
|
||||
prefix: "LOG",
|
||||
@@ -54,69 +61,91 @@ func CreateLogger() *Logger {
|
||||
}
|
||||
}
|
||||
|
||||
// Prefix sets the record prefix and returns the logger for chaining.
|
||||
func (l *Logger) Prefix(prefix string) *Logger {
|
||||
l.prefix = prefix
|
||||
return l
|
||||
}
|
||||
// Level sets the maximum enabled level and returns the logger for chaining.
|
||||
func (l *Logger) Level(level LogLevel) *Logger {
|
||||
l.level = level
|
||||
return l
|
||||
}
|
||||
// PrintTraceback enables traceback output for text writers.
|
||||
func (l *Logger) PrintTraceback(b bool) *Logger {
|
||||
l.printTraceback = b
|
||||
return l
|
||||
}
|
||||
// PrintTime enables timestamps for text writers.
|
||||
func (l *Logger) PrintTime(b bool) *Logger {
|
||||
l.printTime = b
|
||||
return l
|
||||
}
|
||||
// JsonPretty enables indented JSON output for JSON writers.
|
||||
func (l *Logger) JsonPretty(b bool) *Logger {
|
||||
l.jsonPretty = b
|
||||
return l
|
||||
}
|
||||
// AddWriters appends multiple writers to the logger.
|
||||
func (l *Logger) AddWriters(writers ...LoggerWriter) *Logger {
|
||||
l.writers = append(l.writers, writers...)
|
||||
return l
|
||||
}
|
||||
// AddWriter appends a single writer to the logger.
|
||||
func (l *Logger) AddWriter(writer LoggerWriter) *Logger {
|
||||
l.writers = append(l.writers, writer)
|
||||
return l
|
||||
}
|
||||
// Close closes all owned writers and returns a joined error, if any.
|
||||
func (l *Logger) Close() error {
|
||||
var errs []error
|
||||
for _, writer := range l.writers {
|
||||
if writer == nil {
|
||||
continue
|
||||
}
|
||||
err := writer.Close()
|
||||
if err != nil {
|
||||
l.Error(err)
|
||||
errs = append(errs, err)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
l.writers = nil
|
||||
return errors.Join(errs...)
|
||||
}
|
||||
|
||||
// CreateTextWriter wraps an external writer with the logger text settings.
|
||||
func (l *Logger) CreateTextWriter(w io.Writer) *LoggerTextWriter {
|
||||
return CreateTextWriter(w, l.printTraceback, l.printTime)
|
||||
}
|
||||
// CreateTextStdoutWriter creates a non-owning text writer for os.Stdout.
|
||||
func (l *Logger) CreateTextStdoutWriter() *LoggerTextWriter {
|
||||
return CreateTextStdoutWriter(l.printTraceback, l.printTime)
|
||||
}
|
||||
// CreateTextFileWriter creates an owning text writer for a file.
|
||||
func (l *Logger) CreateTextFileWriter(filename string) (*LoggerTextWriter, error) {
|
||||
return CreateTextFileWriter(filename, l.printTraceback, l.printTime)
|
||||
}
|
||||
// CreateJsonWriter wraps an external writer with the logger JSON settings.
|
||||
func (l *Logger) CreateJsonWriter(w io.Writer) *LoggerJsonWriter {
|
||||
return CreateJsonWriter(w, l.jsonPretty)
|
||||
}
|
||||
// CreateJsonStdoutWriter creates a non-owning JSON writer for os.Stdout.
|
||||
func (l *Logger) CreateJsonStdoutWriter() *LoggerJsonWriter {
|
||||
return CreateJsonStdoutWriter(l.jsonPretty)
|
||||
}
|
||||
// CreateJsonFileWriter creates an owning JSON writer for a file.
|
||||
func (l *Logger) CreateJsonFileWriter(filename string) (*LoggerJsonWriter, error) {
|
||||
return CreateJsonFileWriter(filename, l.jsonPretty)
|
||||
}
|
||||
|
||||
// FormatTime converts time to the package text log timestamp format.
|
||||
func FormatTime(t time.Time) string {
|
||||
return fmt.Sprintf("%02d.%02d.%02d %02d:%02d:%02d", t.Day(), t.Month(), t.Year(), t.Hour(), t.Minute(), t.Second())
|
||||
}
|
||||
// FormatTraceback converts a traceback frame to a compact string.
|
||||
func FormatTraceback(mt *MethodTraceback) string {
|
||||
return fmt.Sprintf("%s:%s:%d", mt.Filename, mt.Method, mt.Line)
|
||||
}
|
||||
// FormatFullTraceback joins multiple traceback frames into one string.
|
||||
func FormatFullTraceback(tracebacks []*MethodTraceback) string {
|
||||
formatted := make([]string, 0)
|
||||
for _, tb := range tracebacks {
|
||||
@@ -124,6 +153,7 @@ func FormatFullTraceback(tracebacks []*MethodTraceback) string {
|
||||
}
|
||||
return strings.Join(formatted, "->")
|
||||
}
|
||||
// BuildString renders a text log record using the provided settings.
|
||||
func BuildString(level LogLevel, prefix string, printTime, printTraceback bool, m ...any) string {
|
||||
args := []string{
|
||||
fmt.Sprintf("[%s]", prefix),
|
||||
|
||||
215
logger_test.go
Normal file
215
logger_test.go
Normal file
@@ -0,0 +1,215 @@
|
||||
package slog
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"errors"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
type stubLoggerWriter struct {
|
||||
printErr error
|
||||
closeErr error
|
||||
printCalls int
|
||||
closeCalls int
|
||||
}
|
||||
|
||||
func (w *stubLoggerWriter) Close() error {
|
||||
w.closeCalls++
|
||||
return w.closeErr
|
||||
}
|
||||
|
||||
func (w *stubLoggerWriter) Write(p []byte) (int, error) {
|
||||
return len(p), nil
|
||||
}
|
||||
|
||||
func (w *stubLoggerWriter) Print(_ LogLevel, _ string, _ []*MethodTraceback, _ ...any) error {
|
||||
w.printCalls++
|
||||
return w.printErr
|
||||
}
|
||||
|
||||
func TestLoggerCloseReturnsJoinedErrorsWithoutRelogging(t *testing.T) {
|
||||
firstErr := errors.New("first close failed")
|
||||
secondErr := errors.New("second close failed")
|
||||
first := &stubLoggerWriter{closeErr: firstErr}
|
||||
second := &stubLoggerWriter{closeErr: secondErr}
|
||||
|
||||
logger := CreateLogger().AddWriters(first, second)
|
||||
err := logger.Close()
|
||||
if !errors.Is(err, firstErr) {
|
||||
t.Fatalf("Close() error should include first writer error, got %v", err)
|
||||
}
|
||||
if !errors.Is(err, secondErr) {
|
||||
t.Fatalf("Close() error should include second writer error, got %v", err)
|
||||
}
|
||||
if first.printCalls != 0 || second.printCalls != 0 {
|
||||
t.Fatalf("Close() should not log through writers again, got print calls first=%d second=%d", first.printCalls, second.printCalls)
|
||||
}
|
||||
if first.closeCalls != 1 || second.closeCalls != 1 {
|
||||
t.Fatalf("Close() should close each writer once, got close calls first=%d second=%d", first.closeCalls, second.closeCalls)
|
||||
}
|
||||
if err := logger.Close(); err != nil {
|
||||
t.Fatalf("second Close() should be a no-op, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoggerPrintDoesNotRecurseOnWriterError(t *testing.T) {
|
||||
oldStderr := os.Stderr
|
||||
stderrFile, err := os.CreateTemp(t.TempDir(), "stderr")
|
||||
if err != nil {
|
||||
t.Fatalf("CreateTemp() error = %v", err)
|
||||
}
|
||||
os.Stderr = stderrFile
|
||||
t.Cleanup(func() {
|
||||
os.Stderr = oldStderr
|
||||
_ = stderrFile.Close()
|
||||
})
|
||||
|
||||
bad := &stubLoggerWriter{printErr: errors.New("print failed")}
|
||||
good := &stubLoggerWriter{}
|
||||
|
||||
logger := CreateLogger().AddWriters(bad, good)
|
||||
logger.Error("boom")
|
||||
|
||||
if bad.printCalls != 1 {
|
||||
t.Fatalf("bad writer should be called once, got %d", bad.printCalls)
|
||||
}
|
||||
if good.printCalls != 1 {
|
||||
t.Fatalf("good writer should be called once, got %d", good.printCalls)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCreateTextWriterCloseOnNonCloserIsNoOp(t *testing.T) {
|
||||
writer := CreateTextWriter(&bytes.Buffer{}, false, false)
|
||||
if err := writer.Close(); err != nil {
|
||||
t.Fatalf("Close() error = %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCreateTextWriterDoesNotCloseExternalCloser(t *testing.T) {
|
||||
file, err := os.CreateTemp(t.TempDir(), "text-writer")
|
||||
if err != nil {
|
||||
t.Fatalf("CreateTemp() error = %v", err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_ = file.Close()
|
||||
})
|
||||
|
||||
writer := CreateTextWriter(file, false, false)
|
||||
if err := writer.Close(); err != nil {
|
||||
t.Fatalf("Close() error = %v", err)
|
||||
}
|
||||
if _, err := file.WriteString("still open"); err != nil {
|
||||
t.Fatalf("CreateTextWriter() should not close external writers, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCreateJsonWriterCloseOnNonCloserIsNoOp(t *testing.T) {
|
||||
writer := CreateJsonWriter(&bytes.Buffer{}, false)
|
||||
if err := writer.Close(); err != nil {
|
||||
t.Fatalf("Close() error = %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCreateJsonWriterDoesNotCloseExternalCloser(t *testing.T) {
|
||||
file, err := os.CreateTemp(t.TempDir(), "json-writer")
|
||||
if err != nil {
|
||||
t.Fatalf("CreateTemp() error = %v", err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_ = file.Close()
|
||||
})
|
||||
|
||||
writer := CreateJsonWriter(file, false)
|
||||
if err := writer.Close(); err != nil {
|
||||
t.Fatalf("Close() error = %v", err)
|
||||
}
|
||||
if _, err := file.WriteString("still open"); err != nil {
|
||||
t.Fatalf("CreateJsonWriter() should not close external writers, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCreateTextStdoutWriterDoesNotCloseStdout(t *testing.T) {
|
||||
stdoutFile := swapStdout(t)
|
||||
|
||||
writer := CreateTextStdoutWriter(false, false)
|
||||
if err := writer.Close(); err != nil {
|
||||
t.Fatalf("Close() error = %v", err)
|
||||
}
|
||||
if _, err := stdoutFile.WriteString("still open"); err != nil {
|
||||
t.Fatalf("stdout writer Close() should not close stdout, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCreateJsonStdoutWriterDoesNotCloseStdout(t *testing.T) {
|
||||
stdoutFile := swapStdout(t)
|
||||
|
||||
writer := CreateJsonStdoutWriter(false)
|
||||
if err := writer.Close(); err != nil {
|
||||
t.Fatalf("Close() error = %v", err)
|
||||
}
|
||||
if _, err := stdoutFile.WriteString("still open"); err != nil {
|
||||
t.Fatalf("stdout writer Close() should not close stdout, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetFullTracebackSkipsRuntimeAndSlogFrames(t *testing.T) {
|
||||
tracebacks := captureTracebackForTest()
|
||||
if len(tracebacks) == 0 {
|
||||
t.Fatal("expected at least one traceback frame")
|
||||
}
|
||||
|
||||
first := tracebacks[0]
|
||||
if first.Method != "captureTracebackForTest" {
|
||||
t.Fatalf("first frame should be the nearest user frame, got %s", first.Method)
|
||||
}
|
||||
for _, tb := range tracebacks {
|
||||
if strings.HasPrefix(tb.Signature, "runtime.") {
|
||||
t.Fatalf("runtime frame should be filtered out, got %s", tb.Signature)
|
||||
}
|
||||
if _, ok := internalTracebackMethods[tb.Method]; ok {
|
||||
t.Fatalf("internal slog frame should be filtered out, got %s", tb.Signature)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetTracebackReturnsNearestUserFrame(t *testing.T) {
|
||||
tb := captureSingleTracebackForTest()
|
||||
if tb == nil {
|
||||
t.Fatal("expected traceback frame")
|
||||
}
|
||||
if tb.Method != "captureSingleTracebackForTest" {
|
||||
t.Fatalf("expected nearest user frame, got %s", tb.Method)
|
||||
}
|
||||
if strings.HasPrefix(tb.Signature, "runtime.") {
|
||||
t.Fatalf("runtime frame should be filtered out, got %s", tb.Signature)
|
||||
}
|
||||
if _, ok := internalTracebackMethods[tb.Method]; ok {
|
||||
t.Fatalf("internal slog frame should be filtered out, got %s", tb.Signature)
|
||||
}
|
||||
}
|
||||
|
||||
func swapStdout(t *testing.T) *os.File {
|
||||
t.Helper()
|
||||
|
||||
oldStdout := os.Stdout
|
||||
stdoutFile, err := os.CreateTemp(t.TempDir(), "stdout")
|
||||
if err != nil {
|
||||
t.Fatalf("CreateTemp() error = %v", err)
|
||||
}
|
||||
os.Stdout = stdoutFile
|
||||
t.Cleanup(func() {
|
||||
os.Stdout = oldStdout
|
||||
_ = stdoutFile.Close()
|
||||
})
|
||||
return stdoutFile
|
||||
}
|
||||
|
||||
func captureTracebackForTest() []*MethodTraceback {
|
||||
return getFullTraceback(0)
|
||||
}
|
||||
|
||||
func captureSingleTracebackForTest() *MethodTraceback {
|
||||
return getTraceback()
|
||||
}
|
||||
90
traceback.go
90
traceback.go
@@ -2,59 +2,83 @@ package slog
|
||||
|
||||
import (
|
||||
"runtime"
|
||||
"sort"
|
||||
"strings"
|
||||
)
|
||||
|
||||
func getTraceback() *MethodTraceback {
|
||||
caller, _, _, _ := runtime.Caller(5)
|
||||
details := runtime.FuncForPC(caller)
|
||||
signature := details.Name()
|
||||
path, line := details.FileLine(caller)
|
||||
splitPath := strings.Split(path, "/")
|
||||
|
||||
splitSignature := strings.Split(signature, ".")
|
||||
method := splitSignature[len(splitSignature)-1]
|
||||
|
||||
tb := &MethodTraceback{
|
||||
Filename: splitPath[len(splitPath)-1],
|
||||
FullPath: path,
|
||||
Line: line,
|
||||
Signature: signature,
|
||||
Method: method,
|
||||
}
|
||||
|
||||
return tb
|
||||
var internalTracebackMethods = map[string]struct{}{
|
||||
"Infof": {},
|
||||
"Info": {},
|
||||
"Infoln": {},
|
||||
"Warnf": {},
|
||||
"Warn": {},
|
||||
"Warnln": {},
|
||||
"Errorf": {},
|
||||
"Error": {},
|
||||
"Errorln": {},
|
||||
"Fatalf": {},
|
||||
"Fatal": {},
|
||||
"Fatalln": {},
|
||||
"Debugf": {},
|
||||
"Debug": {},
|
||||
"Debugln": {},
|
||||
"print": {},
|
||||
"println": {},
|
||||
"reportWriterError": {},
|
||||
"getTraceback": {},
|
||||
"getFullTraceback": {},
|
||||
}
|
||||
|
||||
func getTraceback() *MethodTraceback {
|
||||
tracebacks := getFullTraceback(0)
|
||||
if len(tracebacks) == 0 {
|
||||
return nil
|
||||
}
|
||||
return tracebacks[0]
|
||||
}
|
||||
|
||||
func getFullTraceback(skip int) []*MethodTraceback {
|
||||
pc := make([]uintptr, 15)
|
||||
runtime.Callers(skip, pc)
|
||||
n := runtime.Callers(skip+2, pc)
|
||||
list := make([]*MethodTraceback, 0)
|
||||
frames := runtime.CallersFrames(pc)
|
||||
frames := runtime.CallersFrames(pc[:n])
|
||||
for {
|
||||
frame, more := frames.Next()
|
||||
tb := buildMethodTraceback(frame.PC)
|
||||
if tb != nil && !isInternalTraceback(tb) {
|
||||
list = append(list, tb)
|
||||
}
|
||||
if !more {
|
||||
break
|
||||
}
|
||||
details := runtime.FuncForPC(frame.PC)
|
||||
signature := details.Name()
|
||||
path, line := details.FileLine(frame.PC)
|
||||
splitPath := strings.Split(path, "/")
|
||||
}
|
||||
return list
|
||||
}
|
||||
|
||||
func buildMethodTraceback(pc uintptr) *MethodTraceback {
|
||||
details := runtime.FuncForPC(pc)
|
||||
if details == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
signature := details.Name()
|
||||
path, line := details.FileLine(pc)
|
||||
splitPath := strings.Split(path, "/")
|
||||
splitSignature := strings.Split(signature, ".")
|
||||
method := splitSignature[len(splitSignature)-1]
|
||||
|
||||
tb := &MethodTraceback{
|
||||
return &MethodTraceback{
|
||||
Filename: splitPath[len(splitPath)-1],
|
||||
FullPath: path,
|
||||
Line: line,
|
||||
Signature: signature,
|
||||
Method: method,
|
||||
}
|
||||
list = append(list, tb)
|
||||
}
|
||||
sort.Slice(list, func(i, j int) bool {
|
||||
return j < i
|
||||
})
|
||||
return list
|
||||
}
|
||||
|
||||
func isInternalTraceback(tb *MethodTraceback) bool {
|
||||
if strings.HasPrefix(tb.Signature, "runtime.") {
|
||||
return true
|
||||
}
|
||||
_, ok := internalTracebackMethods[tb.Method]
|
||||
return ok
|
||||
}
|
||||
|
||||
1
utils.go
1
utils.go
@@ -1,5 +1,6 @@
|
||||
package slog
|
||||
|
||||
// Map applies f to each element of s and returns the resulting slice.
|
||||
func Map[T, R any](s []T, f func(T) R) []R {
|
||||
out := make([]R, len(s))
|
||||
for i, el := range s {
|
||||
|
||||
93
writers.go
93
writers.go
@@ -1,7 +1,6 @@
|
||||
package slog
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
@@ -11,42 +10,51 @@ import (
|
||||
"time"
|
||||
)
|
||||
|
||||
// LoggerWriter is the common sink interface used by Logger.
|
||||
type LoggerWriter interface {
|
||||
Close() error
|
||||
Write(p []byte) (n int, err error)
|
||||
Print(level LogLevel, prefix string, traceback []*MethodTraceback, messages ...any) error
|
||||
}
|
||||
|
||||
// LoggerTextWriter writes human-readable log records to an io.Writer.
|
||||
type LoggerTextWriter struct {
|
||||
LoggerWriter
|
||||
writer io.Writer
|
||||
closer io.Closer
|
||||
printTraceback bool
|
||||
printTime bool
|
||||
}
|
||||
|
||||
// Write forwards raw bytes to the underlying writer.
|
||||
func (w *LoggerTextWriter) Write(p []byte) (n int, err error) {
|
||||
n, err = w.writer.Write(p)
|
||||
if err != nil {
|
||||
return n, err
|
||||
}
|
||||
err = bufio.NewWriter(w.writer).Flush()
|
||||
return n, err
|
||||
return w.writer.Write(p)
|
||||
}
|
||||
|
||||
// Print formats the provided record as text and writes it to the underlying writer.
|
||||
func (w *LoggerTextWriter) Print(level LogLevel, prefix string, _ []*MethodTraceback, messages ...any) error {
|
||||
s := BuildString(level, prefix, w.printTime, w.printTraceback, messages...)
|
||||
_, err := w.Write([]byte(s))
|
||||
return err
|
||||
}
|
||||
|
||||
// Close closes the owned writer, if any.
|
||||
func (w *LoggerTextWriter) Close() error {
|
||||
return w.writer.(io.Closer).Close()
|
||||
if w.closer == nil {
|
||||
return nil
|
||||
}
|
||||
return w.closer.Close()
|
||||
}
|
||||
|
||||
// LoggerJsonWriter write into writer JSON
|
||||
// LoggerJsonWriter writes structured log records as JSON.
|
||||
type LoggerJsonWriter struct {
|
||||
LoggerWriter
|
||||
writer io.Writer
|
||||
closer io.Closer
|
||||
pretty bool
|
||||
}
|
||||
|
||||
// LoggerJsonMessage is the JSON payload emitted by LoggerJsonWriter.
|
||||
type LoggerJsonMessage struct {
|
||||
Time time.Time `json:"time"`
|
||||
Level string `json:"level"`
|
||||
@@ -55,23 +63,28 @@ type LoggerJsonMessage struct {
|
||||
Traceback []*MethodTraceback `json:"traceback"`
|
||||
}
|
||||
|
||||
// Write forwards raw bytes to the underlying writer.
|
||||
func (w *LoggerJsonWriter) Write(data []byte) (int, error) {
|
||||
n, err := w.writer.Write(data)
|
||||
if err != nil {
|
||||
return n, err
|
||||
}
|
||||
err = bufio.NewWriter(w.writer).Flush()
|
||||
return n, err
|
||||
return w.writer.Write(data)
|
||||
}
|
||||
|
||||
// Print encodes the provided record as JSON and writes it to the underlying writer.
|
||||
func (w *LoggerJsonWriter) Print(level LogLevel, prefix string, traceback []*MethodTraceback, messages ...any) error {
|
||||
msg := Map(messages, func(el any) string {
|
||||
return fmt.Sprintf("%v", el)
|
||||
})
|
||||
|
||||
newline := false
|
||||
if msg[len(msg)-1] == "\n" {
|
||||
newline = true
|
||||
msg = msg[:len(msg)-1]
|
||||
}
|
||||
|
||||
m := LoggerJsonMessage{
|
||||
Time: time.Now(),
|
||||
Level: level.GetName(),
|
||||
Prefix: prefix,
|
||||
Message: strings.Join(msg, " "),
|
||||
Message: strings.TrimSpace(strings.Join(msg, " ")),
|
||||
Traceback: traceback,
|
||||
}
|
||||
var data []byte
|
||||
@@ -84,19 +97,32 @@ func (w *LoggerJsonWriter) Print(level LogLevel, prefix string, traceback []*Met
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
_, err = w.Write(append(data, []byte("\n")...))
|
||||
if newline {
|
||||
data = append(data, '\n')
|
||||
}
|
||||
_, err = w.Write(data)
|
||||
return err
|
||||
}
|
||||
|
||||
// Close closes the owned writer, if any.
|
||||
func (w *LoggerJsonWriter) Close() error {
|
||||
return w.writer.(io.Closer).Close()
|
||||
if w.closer == nil {
|
||||
return nil
|
||||
}
|
||||
return w.closer.Close()
|
||||
}
|
||||
|
||||
// CreateTextWriter wraps an external writer for text output without taking
|
||||
// ownership of it.
|
||||
func CreateTextWriter(w io.Writer, printTraceback, printTime bool) *LoggerTextWriter {
|
||||
writer := &LoggerTextWriter{
|
||||
writer: w, printTraceback: printTraceback, printTime: printTime,
|
||||
}
|
||||
return writer
|
||||
}
|
||||
|
||||
// CreateTextFileWriter creates a text writer for path, creating parent
|
||||
// directories as needed. The returned writer owns the opened file.
|
||||
func CreateTextFileWriter(path string, printTraceback, printTime bool) (*LoggerTextWriter, error) {
|
||||
err := os.MkdirAll(filepath.Dir(path), os.ModePerm)
|
||||
if err != nil {
|
||||
@@ -106,21 +132,38 @@ func CreateTextFileWriter(path string, printTraceback, printTime bool) (*LoggerT
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return CreateTextWriter(file, printTraceback, printTime), nil
|
||||
}
|
||||
func CreateTextStdoutWriter(printTraceback, printTime bool) *LoggerTextWriter {
|
||||
return CreateTextWriter(os.Stdout, printTraceback, printTime)
|
||||
writer := CreateTextWriter(file, printTraceback, printTime)
|
||||
writer.closer = file
|
||||
return writer, nil
|
||||
}
|
||||
|
||||
// CreateTextStdoutWriter creates a text writer for os.Stdout without taking
|
||||
// ownership of stdout.
|
||||
func CreateTextStdoutWriter(printTraceback, printTime bool) *LoggerTextWriter {
|
||||
writer := CreateTextWriter(os.Stdout, printTraceback, printTime)
|
||||
writer.closer = nil
|
||||
return writer
|
||||
}
|
||||
|
||||
// CreateJsonWriter wraps an external writer for JSON output without taking
|
||||
// ownership of it.
|
||||
func CreateJsonWriter(w io.Writer, pretty bool) *LoggerJsonWriter {
|
||||
writer := &LoggerJsonWriter{
|
||||
writer: w, pretty: pretty,
|
||||
}
|
||||
return writer
|
||||
}
|
||||
|
||||
// CreateJsonStdoutWriter creates a JSON writer for os.Stdout without taking
|
||||
// ownership of stdout.
|
||||
func CreateJsonStdoutWriter(pretty bool) *LoggerJsonWriter {
|
||||
return CreateJsonWriter(os.Stdout, pretty)
|
||||
writer := CreateJsonWriter(os.Stdout, pretty)
|
||||
writer.closer = nil
|
||||
return writer
|
||||
}
|
||||
|
||||
// CreateJsonFileWriter creates a JSON writer for path, creating parent
|
||||
// directories as needed. The returned writer owns the opened file.
|
||||
func CreateJsonFileWriter(path string, pretty bool) (*LoggerJsonWriter, error) {
|
||||
err := os.MkdirAll(filepath.Dir(path), os.ModePerm)
|
||||
if err != nil {
|
||||
@@ -130,5 +173,7 @@ func CreateJsonFileWriter(path string, pretty bool) (*LoggerJsonWriter, error) {
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return CreateJsonWriter(file, pretty), nil
|
||||
writer := CreateJsonWriter(file, pretty)
|
||||
writer.closer = file
|
||||
return writer, nil
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user