Repository: mrsarm/mongotail
Branch: master
Commit: 2d7b7c9eac58
Files: 18
Total size: 92.6 KB
Directory structure:
gitextract_t776byha/
├── .github/
│ └── workflows/
│ └── python-app.yml
├── .gitignore
├── AUTHORS.rst
├── CHANGELOG.rst
├── COPYING
├── Dockerfile
├── INSTALL.rst
├── MANIFEST.in
├── Makefile
├── README.rst
├── mongotail/
│ ├── __init__.py
│ ├── conn.py
│ ├── err.py
│ ├── jsondec.py
│ ├── mongotail.py
│ └── out.py
├── setup.cfg
└── setup.py
================================================
FILE CONTENTS
================================================
================================================
FILE: .github/workflows/python-app.yml
================================================
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
name: Python application
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [ '3.8', '3.10', '3.12' ]
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Upgrade Python dependencies
run: |
python -m pip install --upgrade pip setuptools wheel
- name: Test install
run: |
make install
- name: Test run --version
run: |
mongotail --version
- name: Test run --help
run: |
mongotail --help
================================================
FILE: .gitignore
================================================
# Ignore byte compiled files
*.py[co]
build
dist
*.egg-info
# Ignore Eclipse IDE files
.settings
.project
.pydevproject
.directory
# Ignore IDEA files
.idea
*.iml
*.ipr
*.iws
# Profiling files
*.prof
*.cprof
# Others
PyPI*
# Virtual environments
env*/
venv*/
.venv*/
================================================
FILE: AUTHORS.rst
================================================
AUTHORS
=======
Mongotail was originally created and currently maintained by:
* Mariano Ruiz <mrsarm@gmail.com>
CONTRIBUTORS
------------
People who have submitted patches and reported bugs:
* David Castellanos (https://github.com/davidcaste)
* Alexander Nestorov (https://github.com/alexandernst)
* Chris McKee (https://github.com/ChrisMcKee)
* kengruven (https://github.com/kengruven)
* Alex Kucherenko (https://github.com/AlexTiTanium)
* Abhishek Sharma (https://github.com/sharma-abhishek)
* Francois-Guillaume Ribreau (https://github.com/FGRibreau)
* Renzo Parziphal (https://github.com/Parziphal)
* Shane Harvey (https://github.com/ShaneHarvey)
* Viktor Hedefalk (https://github.com/hedefalk)
* Timur Ruziev (https://github.com/resurtm)
* https://github.com/mangel1196
* Ankit (https://github.com/ankit1329)
* Zach (https://github.com/im-zhangxi)
* Patrick Portal (https://github.com/pp0rtal)
* Alex Eimer (https://github.com/aeimer)
* James Bohnert (https://github.com/jsbohnert)
================================================
FILE: CHANGELOG.rst
================================================
Mongotail changelog
===================
3.1.1
-----
* Recognize and support alternate casings of ``findAndModify`` and ``mapReduce``.
3.1.0
-----
* Fix authentication mechanism: was broken with latest PyMongo versions.
* Allows to set the schema in the URI (``mongodb://``).
* Add dependency to connect to MongoDB using the ``mongodb+srv://`` schema.
* Minor fixes in script and configuration files for building the app.
3.0.0
-----
* Add support to the new PyMongo driver version 4.0 (#34).
* Add support to the types ``MinKey`` / ``MaxKey``
from MongoDB (#35).
* Remove deprecated SSL arguments in favor of the
new *TLS* arguments.
* Remove support to Python 2.6, 3.3, and 3.4.
* Fix when a query fails Mongo doesn't
record ``nreturned`` (number of record returned).
* Fix Mongo logs ``killcursors`` operations with different
cases causing exception when parsing logs.
2.4.1
-----
* Fix bug cause "aggregate" queries not be logged.
* Minor rewording of the messages used when
the user checks or changes the profiling level.
2.4.0
-----
* Added support to cursor pagination
arguments in queries: ``limit`` and ``skip``.
2.3.0
-----
* Added BSON ``Timestamp`` type support.
* Moved address parsing code to a new library
called ``res-address`` that now it's a
Mongotail's dependency.
* Support addresses as ``:PORT/DBNAME``,
eg. ``mongotail :123/test``.
* Improved address validations.
2.2.0
-----
* Added support to MongoDB 3.6 log format.
* Added binary data support (``BinData`` type).
* Added python version info to ``--version`` option.
* Now ``insert`` operations with just one document inserted
are showed without ``[]`` notation
* Fixed error when ``insert`` operations doesn't have
recorded the document saved in the profiler
2.1.2
-----
* Fixed #20 CPU runaway using ``-f`` option with local
connections.
* Avoid ``IOError: [Errno 32] Broken pipe`` that some
times is launched when ``Ctrl+C`` is used.
2.1.1
-----
* On ``TypeError`` exceptions dump the output with
warn message instead of exit the program.
* Filtered ``explain`` queries from the log.
2.1.0
-----
* Support ``sort`` parameters logging (compatible with MongoDB 3.2+).
* Support ``NumberDecimal`` type (MongoDB 3.4+).
* Added Docker support.
* Fixed #15 Exception when list collection indexes.
2.0.2
-----
* Fixed exception with ``$out`` operator in aggregation operations.
2.0.1
-----
* Fixed #12 Error when explore the database collections with MongoChef tool.
* Fixed #13 Error "close failed in file object destructor..." after closing
``mongotail -f`` piped with some other command.
* Avoid output of empty metadata results.
2.0.0
-----
* Added support to MongoDB 3.2 log format.
* Added SSL connection support.
* Added ``-m``, ``--metadata`` option to add extra metadata fields to show.
* Added ``-v``, ``--verbose`` option to print all the operations in
JSON without format.
* Added ``-i``, ``--info`` option to get information about the server
we're connected to.
* Added flush calls after output to the ``stderr`` file.
* Added more validations to db address parameter.
1.1.0
-----
* Added support to ``UUID`` data type.
* Fixed formatting error of ``ISODate`` data type when year < 1900 in Python 2.7.
* Fixed unknown operation "createIndexes" output.
* Fixed undesirable operations filters.
1.0.1
-----
* Fixed authentication default mechanism error in MongoDB 3.0
when user and password are used.
1.0.0
-----
* Added support for authentication against another database with
``--authenticationDatabase`` option.
* Fixed unknown operation "killcursors" output.
0.3.2
-----
* Added support to PyMongo 3.0+ due its incompatibility with previous
versions on some API calls.
* When user press Ctrl+"C" now mongotail append a "\n" character to stdout.
* Rollback how javascript code is trimmed.
0.3.1
-----
* Fixed "group" queries logging.
0.3.0
-----
* Added logging to "aggregate", "distinct", "findandmodify",
"map", "group" and "drop" queries.
0.2.0
-----
* Added "status" parameter to ``-l`` or ``-s`` options to see
the current profiling levels. Also where the user changes
the levels, a message in the output standard confirms the operation.
* Fixed imports to avoid install requires exception with ``pip``.
* Removed from MANIFEST invalid license file name entry.
* Changed arbitrary error exit codes by standard *errno* codes.
* Fixed documentation.
0.1.0
-----
First release.
================================================
FILE: COPYING
================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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
<http://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
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
================================================
FILE: Dockerfile
================================================
# Dockerfile to generate a stable image version
# of mongotail: https://hub.docker.com/r/mrsarm/mongotail
#
# Run with: docker run -it --rm mrsarm/mongotail HOST/DB
#
# NOT for development environments
FROM python:3.12-slim
LABEL org.opencontainers.image.authors="Mariano Ruiz <mrsarm@gmail.com>"
RUN pip install --no-cache-dir mongotail==3.1.1
ENTRYPOINT ["mongotail"]
================================================
FILE: INSTALL.rst
================================================
Installing mongotail
====================
Prerequisites
-------------
* Python 3.5+ or 2.7 (only tested with 2.7, 3.5, 3.7, 3.8, 3.10 and 3.12)
* PyMongo 3.12+ (tested with versions 3.12, 4.0, 4.12 and 4.13)
Installation
------------
Once you've installed the dependencies, and downloaded and unpacked
the mongotail source release, enter the directory where the archive
was unpacked, and run::
pip install .
Note that you may need administrator/root privileges for this step, as
this command will by default attempt to install module to the Python
site-packages directory on your system.
For advanced options, please refer to the easy_install and/or the distutils
documentation.
Install requirements in Debian based Linux distribution
-------------------------------------------------------
First, install essential build packages and Python build tools with::
$ apt-get install python3-pip python3-dev build-essential python3-setuptools
================================================
FILE: MANIFEST.in
================================================
include COPYING
include README.rst
include INSTALL.rst
include CHANGELOG.rst
include AUTHORS.rst
================================================
FILE: Makefile
================================================
.PHONY: clean install install-dev uninstall check-mongotail-version build upload upload-test \
install-from-pypi check-version docker-build-image docker-push-image docker-tag-image-latest
.DEFAULT_GOAL := install
VENV ?= venv
SYSTEM_PYTHON = $(or $(shell which python3), $(shell which python))
SYSTEM_PIP = $(or $(shell which pip3), $(shell which pip))
PYTHON = $(or $(wildcard $(VENV)/bin/python), $(SYSTEM_PYTHON))
PIP = $(or $(wildcard $(VENV)/bin/pip), $(SYSTEM_PIP))
# PyPI test repo
TEST_REPO = testpypi
TEST_INDEX_URL = https://test.pypi.org/simple/
# PyPI main repo
MAIN_REPO = pypi
MAIN_INDEX_URL = https://pypi.org/simple/
REPO = ${MAIN_REPO}
INDEX_URL = ${MAIN_INDEX_URL}
PIP_ARGS = --index-url ${MAIN_INDEX_URL}
clean:
rm -fR build/ dist/ .eggs/ mongotail.egg-info/
clean-all: clean
rm -Rf ${VENV}
install:
${PIP} install ${PIP_ARGS} .
# Install mongotail in editable mode, linking the module with the local project path
install-dev: ${VENV}
${PIP} install ${PIP_ARGS} -e .
uninstall:
yes | ${PIP} uninstall mongotail
update-dev-dependencies:
${PIP} install ${PIP_ARGS} -U pip wheel setuptools
${PIP} install ${PIP_ARGS} -U build twine
${VENV}:
${PYTHON} -m venv ${VENV}
$(eval PIP := $(shell echo ${VENV}/bin/pip))
${MAKE} update-dev-dependencies
check-mongotail-version:
${VENV}/bin/mongotail --version
# Build distributable
build:
${PYTHON} -m build
# Upload the distributable packages on PyPI
upload: build
${PYTHON} -m twine upload --repository ${REPO} dist/*
# Upload the distributable packages on test PyPI
upload-test: build
${PYTHON} -m twine upload --repository ${TEST_REPO} dist/*
# Install the distributable package from PyPI
install-from-pypi:
${PYTHON} -m pip install --index-url ${INDEX_URL} --extra-index-url ${MAIN_INDEX_URL} -U --pre mongotail
GREP_VERSION := grep -o -E '[0-9]\.[0-9](\.[0-9])(b[0-9])?'
$(eval DOCKER_VERSION := $(shell cat Dockerfile | ${GREP_VERSION} | head -n 1))
check-version:
ifndef version
second_argument := $(word 2, $(MAKECMDGOALS) )
$(error "version" argument not set. Try 'make version=x.y.z $(filter-out $@, $(MAKECMDGOALS))')
endif
ifeq ($(version),x.y.z)
$(error "version" cannot be equal to "x.y.z", it was just an example :S)
endif
ifneq ($(shell echo $(version) | cut -d'-' -f1),$(DOCKER_VERSION))
$(error mongotail version is ${version}, while version defined in the Dockerfile is ${DOCKER_VERSION})
endif
# Remember to update the version in the Dockerfile first !
docker-build-image: check-version
docker build -t mrsarm/mongotail:${version} .
# Run docker-build-image first
docker-push-image: check-version
docker push mrsarm/mongotail:${version}
# Run docker-push-image first
docker-tag-image-latest: check-version
docker tag mrsarm/mongotail:${version} mrsarm/mongotail:latest
docker push mrsarm/mongotail:latest
================================================
FILE: README.rst
================================================
Mongotail
=========
.. image:: docs/images/mongotail-console.png
Mongotail, Log all `MongoDB <https://www.mongodb.com/>`_ queries in a *"tail"able* way.
``mongotail`` is a command line tool to outputs any operation from a Mongo
database in the standard output. You can see the operations collected by the
database profiler from a console, or redirect the result to a file, pipes
it with ``grep`` or other command line tool, etc.
The syntax is very similar to ``mongo`` client, and the output, as like
``tail`` command will be the latest 10 lines of logging.
But the more interesting feature (also like ``tail``) is to see the changes
in *"real time"* with the ``-f`` option, and occasionally filter the result
with ``grep`` to find a particular operation.
MongoDB version 2.8 and above are supported.
Syntax
------
Usage::
mongotail [db address] [options]
"db address" can be:
+------------------------------+-----------------------------------------------------------------+
| foo | foo database on local machine (IPv4 connection) |
+------------------------------+-----------------------------------------------------------------+
| :1234/foo | foo database on local machine on port 1234 |
+------------------------------+-----------------------------------------------------------------+
| 192.169.0.5/foo | foo database on 192.168.0.5 machine |
+------------------------------+-----------------------------------------------------------------+
| remotehost/foo | foo database on *remotehost* machine |
+------------------------------+-----------------------------------------------------------------+
| user:pass@host/foo | foo database on *host* machine, with user and pass provided |
+------------------------------+-----------------------------------------------------------------+
| 192.169.0.5:9999/foo | foo database on 192.168.0.5 machine on port 9999 |
+------------------------------+-----------------------------------------------------------------+
| "[::1]:9999/foo" | foo database on ::1 machine on port 9999 (IPv6 connection) |
+------------------------------+-----------------------------------------------------------------+
| mongodb://10.0.0.4:9999/foo | foo resource on 10.0.0.4 machine on port 9999, scheme mongodb |
+------------------------------+-----------------------------------------------------------------+
| mongodb+srv://user@host/foo | foo resource on *host* machine, scheme mongodb+srv and username |
+------------------------------+-----------------------------------------------------------------+
*New in 3.1*: URIs with schemas ``mongodb://`` and ``mongodb+srv://`` are supported,
e.g. ``mongodb://host:1234/foo``, and user and password can also be set in the URI,
although it's a very insecure way of provide that information. See bellow
how to provide authentication information like user, password, auth database, ...
**Optional arguments**:
-u USERNAME, --username USERNAME
username for authentication
-p PASSWORD, --password PASSWORD
password for authentication. If username is given and
password isn't, it's asked from tty
-b AUTH_DATABASE, --authenticationDatabase AUTH_DATABASE
database to use to authenticate the user. If not
specified, the user will be authenticated against the
database specified in the [db address]
-n N, --lines N output the last N lines, instead of the last 10. Use
ALL value to show all lines
-f, --follow output appended data as the log grows
-l LEVEL, --level LEVEL
specifies the profiling level, which is either 0 for
no profiling, 1 for only slow operations, or 2 for all
operations. Or use with 'status' word to show the
current level configured. Uses this option once before
logging the database
-s MS, --slowms MS sets the threshold in milliseconds for the profile to
consider a query or operation to be slow (use with
`--level 1`). Or use with 'status' word to show the
current milliseconds configured
-m METADATA, --metadata METADATA
extra metadata fields to show. Known fields may vary
depending of the operation and the MongoDB version:
millis, nscanned, docsExamined, execStats, lockStats ...
(pass each METADATA field separated by one space)
-i, --info get information about the MongoDB server we're connected to
-v, --verbose verbose mode (not recommended). All the operations will
printed in JSON without format and with all the
information available from the log
--tls creates the connection to the server using
transport layer security
--tlsCertificateKeyFile TLSCERTIFICATEKEYFILE
client certificate to connect against MongoDB.
It's the concatenation of both the private key and and
the certificate file
--tlsAllowInvalidCertificates
disable the requirement of a certificate from the
server when TLS is enabled
--tlsCAFile TLSCAFILE
file that contains a set of concatenated CA certificates,
which are used to validate certificates passed
from the other end of the connection
--tlsCertificateKeyFilePassword TLSCERTIFICATEKEYFILEPASSWORD
password or passphrase to decrypt the encrypted private
keys if the private key contained in the
certificate keyfile is encrypted.
--tlsCRLFile TLSCRLFILE
path to a PEM or DER formatted certificate revocation list
-h, --help show this help message and exit
-V, --version show program's version number and exit
Enabling Database Profiling and Showing Logs
--------------------------------------------
First you have to activate in the current database the
`profiler <https://www.mongodb.com/docs/manual/reference/method/db.setProfilingLevel/>`_,
so MongoDB will capture all the activity in a special collection that is read by Mongotail.
You can achieve this with the ``-l, --level`` option. For example, if you want to see the logs
from MYDATABASE, first you have to execute::
$ mongotail MYDATABASE -l 2
Then you can see the latest logged records with::
$ mongotail MYDATABASE
2015-02-24 19:17:01.194 QUERY [Company] : {"_id": ObjectId("548b164144ae122dc430376b")}. 1 returned.
2015-02-24 19:17:01.195 QUERY [User] : {"_id": ObjectId("549048806b5d3db78cf6f654")}. 1 returned.
2015-02-24 19:17:01.196 UPDATE [Activation] : {"_id": "AB524"}, {"_id": "AB524", "code": "f2cbad0c"}. 1 updated.
2015-02-24 19:17:10.729 COUNT [User] : {"active": {"$exists": true}, "firstName": {"$regex": "mac"}}
...
To Connect with SSL or a remote Mongo instance, check the options with ``mongotail --help``.
Profiling considerations
^^^^^^^^^^^^^^^^^^^^^^^^
**NOTE**: The level chosen can affect performance. It also can allow the
server to write the content of queries to the log, which might have
information security implications for your deployment. Remember to setup your
database profiling level to ``0`` again after debugging your data::
$ mongotail MYDATABASE -l 0
Find slow queries
^^^^^^^^^^^^^^^^^
When you activate the profiler, you can choose to so with level 1 profiling
instead of level 2. Level 1 configure the profiler system to log only "slow" operations.
Then you have to set the threshold in milliseconds for the profile to consider an
operation "slow". In the following example the threshold is set to 10 milliseconds::
$ mongotail sales -l 1
Profiling set to level 1
$ mongotail sales -s 10
Threshold profiling set to 10 milliseconds
Then when you check your databases only operations that take 10 or more milliseconds
will be displayed.
A *step-by-step* guide of how to use Mongotail and the latest features
is `here <https://mrsarm.blogspot.com/2016/08/mongotail-2-0-with-new-features-mongodb-3-2-support.html>`_.
Installation
------------
See `INSTALL.rst <https://github.com/mrsarm/mongotail/blob/master/INSTALL.rst>`_
guide to install from sources. To install
from `PyPI repositories <https://pypi.org/project/mongotail/>`_,
follow these instructions depending of your OS:
Linux Installation
^^^^^^^^^^^^^^^^^^
You can install the latest stable version with ``pip`` in your
environment, but it's recommended to install it with
Python 3 (``pip3``)::
$ pip3 install mongotail
Execute this command with administrator/root privileges (in
Debian/Ubuntu Linux distribution prepend ``sudo`` to the command).
You have to be installed ``pip`` / ``pip3`` tool first. In Debian/Ubuntu Linux
distribution you can install it with (also with root privileges)::
$ apt-get install python3-pip
Install mongotail in the user space without root privileges is also
possible with::
$ pip3 install --user mongotail
Note that the ``mongotail`` executable will be installed in the ``$HOME/.local/bin``
folder. If the folder didn't exist before, Pip will create it, but in the
shell console the path won't be added to the ``$PATH`` variable until Bash is not
instantiated again, so to be able to execute the command without the need to use
the full path (``$HOME/.local/bin/mongotail``) just open a new Bash session.
Mac OSX Installation
^^^^^^^^^^^^^^^^^^^^
First you need to install the Python package manager ``pip`` in
your environment, and then like Linux to install Mongotail you
can execute ``sudo pip install mongotail`` from the command line,
but also it can be installed with ``easy_install``, an
old Python package manager present in most OSX versions. Try this::
$ sudo easy_install mongotail
Docker
^^^^^^
Run with Docker (you don't need to download the source code)::
$ docker run -it --rm mrsarm/mongotail --help
If you want to connect with a database also running locally in a
container, you have to link both instances (see howto in the Docker
documentation), or if the db is a local instance running without
Docker, remember to use the local IP of your computer because the
``localhost`` address (IP 127.0.0.1) points to the container, not to
your host. Eg.::
$ docker run -it --rm mrsarm/mongotail 192.168.0.21/test
If it does not work, it may be related with network access rules,
or because the mongo instance is not listening remote connections,
check to have properly configured the
`IP Binding <https://www.mongodb.com/docs/manual/core/security-mongodb-configuration/>`_.
About
-----
Project: https://github.com/mrsarm/mongotail
Authors: (2015-2023) Mariano Ruiz <mrsarm@g...l.com>
Changelog: `CHANGELOG.rst <https://github.com/mrsarm/mongotail/blob/master/CHANGELOG.rst>`_
More guides: https://mrsarm.blogspot.com/search/label/Mongotail
License: GPL-3
================================================
FILE: mongotail/__init__.py
================================================
# -*- coding: utf-8 -*-
##############################################################################
#
# Mongotail, Log all MongoDB queries in a "tail"able way.
# Copyright (C) 2015-2023 Mariano Ruiz <https://github.com/mrsarm/mongotail>
#
# Author: Mariano Ruiz <mrsarm@gmail.com>
#
# 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 <http://www.gnu.org/licenses/>.
#
##############################################################################
__author__ = 'Mariano Ruiz'
__version__ = '3.1.1'
__license__ = 'GPL-3'
__url__ = 'https://github.com/mrsarm/mongotail'
__doc__ = """Mongotail, Log all MongoDB queries in a "tail"able way."""
__usage__ = """%(prog)s [db address] [options]
db address can be:
foo foo database on local machine (IPv4 connection)
:1234/foo foo database on local machine on port 1234
192.169.0.5/foo foo database on 192.168.0.5 machine
192.169.0.5:999/foo foo database on 192.168.0.5 machine on port 999
remotehost/foo foo database on remotehost machine
"[::1]:9999/foo" foo database on ::1 machine on port 9999 (IPv6)
mongodb://10.0.0.4/foo foo database at mongodb://10.0.0.4
mongodb://user@host/foo foo database at mongodb://host and username set
mongodb+srv://some.host/foo foo database at mongodb+srv://some.host"""
================================================
FILE: mongotail/conn.py
================================================
# -*- coding: utf-8 -*-
##############################################################################
#
# Mongotail, Log all MongoDB queries in a "tail"able way.
# Copyright (C) 2015-2022 Mariano Ruiz <https://github.com/mrsarm/mongotail>
#
# Author: Mariano Ruiz <mrsarm@gmail.com>
#
# 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 <http://www.gnu.org/licenses/>.
#
##############################################################################
from __future__ import absolute_import
import getpass
from .err import error, error_parsing, ECONNREFUSED
from pymongo import MongoClient
from res_address import get_res_address, AddressError
def connect(address, args):
"""
Connect with `address`, and return a tuple with a :class:`~pymongo.MongoClient`,
and a :class:`~pymongo.database.Database` object.
:param address: a string representation with the db address
:param args: connection arguments:
- username: username for authentication (optional)
- password: password for authentication. If username is given and password isn't,
it's asked from tty.
- auth_database: authenticate the username and password against that database (optional).
If not specified, the database specified in address will be used.
- tls, tlsCertificateKeyFile, tlsAllowInvalidCertificates, ...: TSL authentication options
:return: a tuple with ``(client, db)``
"""
try:
scheme, host, port, dbname, query, username, password = get_res_address(address)
except AddressError as e:
error_parsing(str(e).replace("resource", "database"))
try:
options = {}
if args.tls:
options["tls"] = True
if args.tlsCertificateKeyFile:
options["tlsCertificateKeyFile"] = args.tlsCertificateKeyFile
if args.tlsCertificateKeyFilePassword:
options["tlsCertificateKeyFilePassword"] = args.tlsCertificateKeyFilePassword
if args.tlsCAFile:
options["tlsCAFile"] = args.tlsCAFile
if args.tlsCRLFile:
options["tlsCRLFile"] = args.tlsCRLFile
if args.tlsAllowInvalidCertificates:
options["tlsAllowInvalidCertificates"] = args.tlsAllowInvalidCertificates
if args.auth_database:
options["authSource"] = args.auth_database
user = args.username or username
if user:
options["username"] = user
passw = args.password or password
if passw is None:
passw = getpass.getpass()
options["password"] = passw if passw != '' else None
if scheme:
client = MongoClient(address, **options)
else:
client = MongoClient(host=host, port=port, **options)
except Exception as e:
error("Error trying to connect: %s" % str(e), ECONNREFUSED)
db = client[dbname]
return client, db
================================================
FILE: mongotail/err.py
================================================
# -*- coding: utf-8 -*-
##############################################################################
#
# Mongotail, Log all MongoDB queries in a "tail"able way.
# Copyright (C) 2015-2019 Mariano Ruiz <https://github.com/mrsarm/mongotail>
#
# Author: Mariano Ruiz <mrsarm@gmail.com>
#
# 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 <http://www.gnu.org/licenses/>.
#
##############################################################################
import sys
from errno import EINVAL, EINTR, ECONNREFUSED, EFAULT, EDESTADDRREQ
def warn(msg):
sys.stderr.write("Mongotail EXCEPTION - %s\n" % msg)
sys.stderr.flush()
def error(msg, exit_code):
"""
Print `msg` error and exit with status `exit_code`
"""
sys.stderr.write("%s\ntry 'mongotail --help' for more information\n" % msg)
sys.stderr.flush()
exit(exit_code)
def error_parsing(msg="unknown options"):
"""
Print any parsing error and exit with status -1
"""
sys.stderr.write("Error parsing command line: %s\ntry 'mongotail --help' for more information\n" % msg)
sys.stderr.flush()
exit(EINVAL)
def error_unknown():
"""
Print an unexpected error and exit with status -5
"""
sys.stderr.write("Unknown Error\ntry 'mongotail --help' for more information\n")
sys.stderr.flush()
exit(-1)
================================================
FILE: mongotail/jsondec.py
================================================
# -*- coding: utf-8 -*-
##############################################################################
#
# Mongotail, Log all MongoDB queries in a "tail"able way.
# Copyright (C) 2015-2022 Mariano Ruiz <https://github.com/mrsarm/mongotail>
#
# Author: Mariano Ruiz <mrsarm@gmail.com>
#
# 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 <http://www.gnu.org/licenses/>.
#
##############################################################################
import re, json
from bson import ObjectId, DBRef, regex, MinKey, MaxKey
from bson.decimal128 import Decimal128
from bson.timestamp import Timestamp
from datetime import datetime
from uuid import UUID
import base64
REGEX_TYPE = type(re.compile(""))
class JSONEncoder(json.JSONEncoder):
def default(self, o):
if isinstance(o, ObjectId):
return "ObjectId(%sObjectId)" % str(o)
if isinstance(o, UUID):
return "UUID(%sUUID)" % str(o)
if isinstance(o, DBRef):
return "DBRef(Field(%sField), ObjectId(%sObjectId)DBRef)" % (o.collection, str(o.id))
if isinstance(o, datetime):
try:
return "ISODate(" + o.strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] + "ZISODate)"
except ValueError:
return "ISODate(" + o.isoformat()[:-3] + "ZISODate)"
if isinstance(o, Timestamp):
return "Timestamp(%s, %sTimestamp)" % (o.time, o.inc)
if isinstance(o, (REGEX_TYPE, regex.Regex)):
return {"$regex": o.pattern}
if isinstance(o, Decimal128):
return "NumberDecimal(" + str(o) + "NumberDecimal)"
if isinstance(o, MinKey):
return "MinKey(MinKey)"
if isinstance(o, MaxKey):
return "MinKey(MinKey)"
if isinstance(o, bytes):
return 'BinData(0,' + base64.b64encode(o).decode('utf-8') + 'BinData)'
return json.JSONEncoder.default(self, o)
def encode(self, o):
result = super(JSONEncoder, self).encode(o)
result = result.replace('Field(', '"')
result = result.replace("Field)", '"')
result = result.replace('ObjectId(', 'ObjectId("')
result = result.replace('"ObjectId(', 'ObjectId(')
result = result.replace('ObjectId)"', '")')
result = result.replace('ObjectId)', '")')
result = result.replace('"DBRef(', 'DBRef(')
result = result.replace('DBRef)"', ')')
result = result.replace('"ISODate(', 'ISODate("')
result = result.replace('ISODate)"', '")')
result = result.replace('"Timestamp(', 'Timestamp(')
result = result.replace('Timestamp)"', ')')
result = result.replace('"UUID(', 'UUID("')
result = result.replace('UUID)"', '")')
result = result.replace('"NumberDecimal(', 'NumberDecimal("')
result = result.replace('NumberDecimal)"', '")')
result = result.replace('"MinKey(', 'MinKey(')
result = result.replace('MinKey)"', ')')
result = result.replace('"MaxKey(', 'MaxKey(')
result = result.replace('MaxKey)"', ')')
result = result.replace('"BinData(0,', 'BinData(0,"')
result = result.replace('BinData)"', '")')
return result
def encode_number(self, num):
"""
For some reason, the profiler store integers as float,
eg. limit and skip arguments
"""
if isinstance(num, float) and num.is_integer():
return str(int(num))
return str(num)
================================================
FILE: mongotail/mongotail.py
================================================
#!/usr/bin/env python
# -*- coding: utf-8 -*-
##############################################################################
#
# Mongotail, Log all MongoDB queries in a "tail"able way.
# Copyright (C) 2015-2022 Mariano Ruiz <https://github.com/mrsarm/mongotail>
#
# Author: Mariano Ruiz <mrsarm@gmail.com>
#
# 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 <http://www.gnu.org/licenses/>.
#
##############################################################################
from __future__ import absolute_import
import sys, re, argparse
from errno import ECONNREFUSED
from .conn import connect
from .out import print_obj
from .err import error, error_parsing, EINTR, EDESTADDRREQ
from pymongo.read_preferences import ReadPreference
from pymongo.errors import ConnectionFailure, OperationFailure
from . import __version__, __doc__, __url__, __usage__
DEFAULT_LIMIT = 10
LOG_QUERY = {
"ns": re.compile(r"^((?!(admin\.\$cmd|\.system|\.tmp\.)).)*$"),
"command.profile": {"$exists": False},
"command.collStats": {"$exists": False},
"command.collstats": {"$exists": False},
"command.createIndexes": {"$exists": False},
"command.listIndexes": {"$exists": False},
#"command.cursor": {"$exists": False},
"command.create": {"$exists": False},
"command.dbstats": {"$exists": False},
"command.scale": {"$exists": False},
"command.explain": {"$exists": False},
"command.killCursors": {"$exists": False},
"command.count": {"$ne": "system.profile"},
"op": re.compile(r"^((?!(getmore|killcursors)).)", re.IGNORECASE),
}
LOG_FIELDS = ['ts', 'op', 'ns', 'query', 'updateobj', 'command', 'ninserted', 'ndeleted', 'nMatched', 'nreturned']
def tail(client, db, lines, follow, verbose, metadata):
if verbose:
fields = None # All fields
elif metadata:
fields = LOG_FIELDS + metadata
else:
fields = LOG_FIELDS
profile_collection = db.system.profile
cursor = profile_collection.find(LOG_QUERY, projection=fields)
if lines.upper() != "ALL":
try:
lines = int(lines)
except ValueError:
error_parsing('Invalid lines number "%s"' % lines)
skip = profile_collection.count_documents(LOG_QUERY) - lines
if skip > 0:
cursor.skip(skip)
if follow:
cursor.add_option(2) # Set the tailable flag
cursor.add_option(32) # Set the await data flag.
server_version = client.server_info()['version']
while cursor.alive:
for result in cursor:
print_obj(result, verbose, metadata, server_version)
def show_profiling_level(client, db):
try:
level = db.command("profile", -1)
sys.stdout.write("Profiling currently set in level %s\n" % level["was"])
except Exception as e:
error('Error trying to get profiling level. %s' % e, EINTR)
def set_profiling_level(client, db, level):
try:
db.command("profile", int(level))
sys.stdout.write("Profiling set to level %s\n" % level)
except Exception as e:
err = str(e).replace("OFF", "0").replace("SLOW_ONLY", "1").replace("ALL", "2")
error('Error configuring profiling level to "%s". %s' % (level, err), EINTR)
def set_slowms_level(client, db, slowms):
profiling_level = db.command("profile", -1)["was"]
try:
db.command({"profile": profiling_level, "slowms": int(slowms)})
sys.stdout.write("Threshold profiling set to %s milliseconds\n" % slowms)
except Exception as e:
error('Error configuring threshold profiling in "%s" milliseconds. %s' % (slowms, str(e)), EINTR)
def show_slowms_level(client, db):
try:
level = db.command("profile", -1, read_preference=ReadPreference.PRIMARY)
sys.stdout.write("Threshold profiling currently in %s milliseconds\n" % level['slowms'])
except Exception as e:
error('Error trying to get threshold profiling level. %s' % e, EINTR)
def show_server_info(client, db):
try:
info = client.server_info()
out = ""
if 'version' in info:
out += "Version: %s\n" % info['version']
if 'buildEnvironment' in info:
if 'target_arch' in info['buildEnvironment']:
out += "Distribution: %s\n" % info['buildEnvironment']['target_arch']
if 'target_os' in info['buildEnvironment']:
out += "Target OS: %s\n" % info['buildEnvironment']['target_os']
elif 'bits' in info:
out += "Distribution: "
if info['bits'] == 64:
out += "x86_64\n"
elif info['bits'] == 32:
out += "x86\n"
else:
out += "%s bits\n" % info['bits']
if 'openssl' in info and 'running' in info['openssl']:
out += "OpenSSL running: %s\n" % info['openssl']['running']
if 'maxBsonObjectSize' in info:
out += "Max BSON Object Size: %s\n" % info['maxBsonObjectSize']
if 'debug' in info:
out += "Debug: %s\n" % str(info['debug'])
if 'javascriptEngine' in info:
out += "Javascript Engine: %s\n" % info['javascriptEngine']
sys.stdout.write(out)
except Exception as e:
error('Error trying to get server info. %s' % e, EINTR)
def main():
try:
# Parsing command line options
parser = argparse.ArgumentParser(description=__doc__, usage=__usage__)
egroup = parser.add_mutually_exclusive_group()
parser.add_argument("-u", "--username", dest="username", default=None,
help="username for authentication")
parser.add_argument("-p", "--password", dest="password", default=None,
help="password for authentication. If username is given and password isn't, "
"it's asked from tty")
parser.add_argument("-b", "--authenticationDatabase", dest="auth_database", default=None,
help="database to use to authenticate the user. If not specified, the user "
"will be authenticated against the database specified in the [db address]")
parser.add_argument("-n", "--lines", dest="n", default=str(DEFAULT_LIMIT),
help="output the last N lines, instead of the last 10. Use ALL value to show all lines")
parser.add_argument("-f", "--follow", dest="follow", action="store_true", default=False,
help="output appended data as the log grows")
parser.add_argument("-l", "--level", dest="level", default=None,
help="specifies the profiling level, which is either 0 for no profiling, "
"1 for only slow operations, or 2 for all operations. Or use with 'status' word "
"to show the current level configured. "
"Uses this option once before logging the database")
parser.add_argument("-s", "--slowms", dest="ms", default=None,
help="sets the threshold in milliseconds for the profile to consider a query "
"or operation to be slow (use with `--level 1`). Or use with 'status' word "
"to show the current milliseconds configured")
parser.add_argument("-m","--metadata", nargs="*",
help="extra metadata fields to show. "
"Known fields (may vary depending of the operation and the MongoDB version): "
"millis, nscanned, docsExamined, execStats, lockStats ...")
parser.add_argument("-i", "--info", dest="info", action="store_true", default=False,
help="get information about the MongoDB server we're connected to")
parser.add_argument("-v", "--verbose", dest="verbose", action="store_true", default=False,
help="verbose mode (not recommended). All the operations will printed in JSON without "
"format and with all the information available from the log")
parser.add_argument("--tls", action="store_true", default=False,
help ="creates the connection to the server using transport layer security")
parser.add_argument("--tlsCertificateKeyFile", dest="tlsCertificateKeyFile", default=None,
help="client certificate to connect against MongoDB. It's the concatenation of "
"both the private key and and the certificate file")
parser.add_argument("--tlsAllowInvalidCertificates", dest="tlsAllowInvalidCertificates",
action="store_true", default=False,
help="disable the requirement of a certificate from the server when TLS is enabled")
parser.add_argument("--tlsCAFile", dest="tlsCAFile", default=None,
help="file that contains a set of concatenated CA "
"certificates, which are used to validate certificates passed from the other "
"end of the connection")
parser.add_argument("--tlsCertificateKeyFilePassword", dest="tlsCertificateKeyFilePassword", default=None,
help="password or passphrase to decrypt the encrypted private keys if the "
"private key contained in the certificate keyfile is encrypted")
parser.add_argument("--tlsCRLFile", dest="tlsCRLFile", default=None,
help="path to a PEM or DER formatted certificate revocation list")
parser.add_argument("-V", "--version", action="version",
version="%(prog)s " + __version__ + " <" + __url__ + "> (python " + sys.version.split(" ")[0] + ")")
args, address = parser.parse_known_args()
if address and len(address) and address[0] == sys.argv[1]:
address = address[0]
elif len(address) == 0:
error("db address expected", EDESTADDRREQ)
else:
error_parsing()
if address.startswith("-"):
error_parsing()
# Getting connection
client, db = connect(address, args)
# Execute command
if args.level:
if args.level.lower() == "status":
show_profiling_level(client, db)
else:
set_profiling_level(client, db, args.level)
elif args.ms:
if args.ms.lower() == "status":
show_slowms_level(client, db)
else:
set_slowms_level(client, db, args.ms)
elif args.info:
show_server_info(client, db)
else:
tail(client, db, args.n, args.follow, args.verbose, args.metadata)
except KeyboardInterrupt:
try:
sys.stdout.write("\n")
sys.stdout.flush()
sys.stderr.flush()
except IOError:
pass # Avoid `IOError: [Errno 32] Broken pipe` that sometimes is launched when `Ctrl+C` is used
except ConnectionFailure as e:
error("Error trying to authenticate: %s" % str(e), ECONNREFUSED)
except OperationFailure as e:
if 'errmsg' in e.details:
sys.stderr.write("Operation failure: %s\n" % e.details['errmsg'])
sys.stderr.flush()
exit(e.details['code'])
error("Error trying to authenticate: %s" % str(e), 3)
if __name__ == "__main__":
main()
================================================
FILE: mongotail/out.py
================================================
# -*- coding: utf-8 -*-
##############################################################################
#
# Mongotail, Log all MongoDB queries in a "tail"able way.
# Copyright (C) 2015-2023 Mariano Ruiz <https://github.com/mrsarm/mongotail>
#
# Author: Mariano Ruiz <mrsarm@gmail.com>
#
# 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 <http://www.gnu.org/licenses/>.
#
##############################################################################
from __future__ import absolute_import
import collections
import sys
from .jsondec import JSONEncoder
from .err import warn
json_encoder = JSONEncoder()
def print_obj(obj, verbose, metadata, mongo_version):
"""
Print the dict returned by a MongoDB Query in the standard output.
"""
if verbose:
sys.stdout.write(json_encoder.encode(obj) + '\n')
sys.stdout.flush()
else:
try:
ts_time = obj['ts']
operation = obj['op']
doc = None
if operation == 'query':
if mongo_version < "3.2":
doc = obj['ns'].split(".")[-1]
query = json_encoder.encode(obj['query']) if 'query' in obj else "{}"
else:
if "query" in obj:
cmd = obj['query'] # Mongo 3.2 - 3.4
else:
cmd = obj['command'] # Mongo 3.6+
doc = cmd['find']
query = json_encoder.encode(cmd['filter']) if 'filter' in cmd else "{}"
if 'sort' in cmd:
query += ', sort: ' + json_encoder.encode(cmd['sort'])
if 'limit' in cmd:
query += ', limit: ' + json_encoder.encode_number(cmd['limit'])
if 'skip' in cmd:
query += ', skip: ' + json_encoder.encode_number(cmd['skip'])
if 'nreturned' in obj:
# If a query fails Mongo doesn't record nreturned
query += '. %s returned.' % obj['nreturned']
elif operation == 'update':
doc = obj['ns'].split(".")[-1]
if mongo_version < "3.6":
query = json_encoder.encode(obj['query']) if 'query' in obj else "{}"
query += ', ' + json_encoder.encode(obj['updateobj'])
else:
query = json_encoder.encode(obj['command']['q']) if 'command' in obj and 'q' in obj['command'] else "{}"
query += ', ' + json_encoder.encode(obj['command']['u'])
if 'nModified' in obj:
query += '. %s updated.' % obj['nModified']
elif 'nMatched' in obj:
query += '. %s updated.' % obj['nMatched']
elif operation == 'insert':
if mongo_version < "3.2":
doc = obj['ns'].split(".")[-1]
query = json_encoder.encode(obj['query']) if 'query' in obj else "{}"
else:
if 'query' in obj:
doc = obj['query']['insert']
if 'documents' in obj['query']:
if isinstance(obj['query']['documents'], collections.Iterable) \
and len(obj['query']['documents']) > 1:
query = json_encoder.encode(obj['query']['documents']) + ". "
else:
query = json_encoder.encode(obj['query']['documents'][0]) + ". "
else:
query = ""
else:
# Mongo 3.6+ profiler looks like doens't record insert details (document object), and
# some tools like Robo 3T (formerly Robomongo) allows to duplicate collections
# but the profiler doesn't record the element inserted
doc = obj['ns'].split(".")[-1]
query = ""
query += '%s inserted.' % obj['ninserted']
elif operation == 'remove':
doc = obj['ns'].split(".")[-1]
if mongo_version < "3.6":
query = json_encoder.encode(obj['query']) if 'query' in obj else "{}"
else:
query = json_encoder.encode(obj['command']['q']) if 'command' in obj and 'q' in obj['command'] else "{}"
query += '. %s deleted.' % obj['ndeleted']
elif operation == "command":
if 'count' in obj["command"]:
operation = "count"
query = json_encoder.encode(obj['command']['query'])
elif 'aggregate' in obj["command"]:
operation = "aggregate"
query = json_encoder.encode(obj['command']['pipeline'])
elif 'distinct' in obj["command"]:
operation = "distinct"
query = json_encoder.encode(obj['command']['query'])
query = '"%s", %s' % (obj['command']['key'], query)
elif 'drop' in obj["command"]:
operation = "drop"
query = ""
elif 'findandmodify' in obj["command"] or 'findAndModify' in obj["command"]:
operation = "findandmodify" in obj["command"] and "findandmodify" or "findAndModify"
query = "query: " + json_encoder.encode(obj['command']['query'])
if 'sort' in obj["command"]:
query += ", sort: " + json_encoder.encode(obj['command']['sort'])
if 'update' in obj["command"]:
query += ", update: " + json_encoder.encode(obj['command']['update'])
if 'remove' in obj["command"]:
query += ", remove: " + str(obj['command']['remove']).lower()
if 'fields' in obj["command"]:
query += ", fields: " + json_encoder.encode(obj['command']['fields'])
if 'upsert' in obj["command"]:
query += ", upsert: " + str(obj['command']['upsert']).lower()
if 'new' in obj["command"]:
query += ", new: " + str(obj['command']['new']).lower()
elif 'group' in obj["command"]:
operation = "group"
doc = obj["command"]['group']["ns"]
if 'key' in obj['command']['group']:
key = "key: " + json_encoder.encode(obj['command']['group']['key'])
else:
key = None
if 'initial' in obj['command']['group']:
initial = "initial: " + json_encoder.encode(obj['command']['group']['initial'])
else:
initial = None
if 'cond' in obj['command']['group']:
cond = "cond: " + json_encoder.encode(obj['command']['group']['cond'])
else:
cond = None
if '$keyf' in obj['command']['group']:
key_function = "keyf: " + min_script(obj['command']['group']['$keyf'])
else:
key_function = None
if '$reduce' in obj['command']['group']:
reduce_func = "reduce: " + min_script(obj['command']['group']['$reduce'])
else:
reduce_func = None
if 'finalize' in obj['command']['group']:
finalize_func = "finalize: " + min_script(obj['command']['group']['finalize'])
else:
finalize_func = None
query = ", ".join(list(filter(lambda x: x, (key, reduce_func, initial, key_function, cond, finalize_func))))
elif 'map' in obj["command"]:
operation = "map"
mapreduce_key = "mapreduce" in obj["command"] and "mapreduce" or "mapReduce"
doc = obj["command"][mapreduce_key]
del obj["command"][mapreduce_key]
map_func = min_script(obj['command']["map"])
del obj['command']["map"]
reduce_func = min_script(obj['command']["reduce"])
del obj['command']["reduce"]
query = "{%s, %s, %s}" % (map_func, reduce_func, json_encoder.encode(obj['command']))
else:
warn('Unknown command operation\nDump: %s' % json_encoder.encode(obj))
if not doc:
doc = obj["command"][operation]
else:
warn('Unknown operation "%s"\nDump: %s' % (operation, json_encoder.encode(obj)))
if metadata:
met = []
for m in metadata:
if m in obj and obj[m] != {}:
q = m + ": "
if isinstance(obj[m], str):
q += '"%s"' % obj[m]
elif isinstance(obj[m], dict):
q += json_encoder.encode(obj[m])
else:
q += str(obj[m])
met.append(q)
if met:
if not query.endswith("."): query += ". "
if not query.endswith(" "): query += " "
query += ", ".join(met)
sys.stdout.write("%s %s [%s] : %s\n" % (ts_time.strftime("%Y-%m-%d %H:%M:%S.%f")[:-3],
operation.upper().ljust(9), doc, query))
sys.stdout.flush() # Allows pipe the output during the execution with others tools like 'grep'
except (KeyError, TypeError):
warn('Unknown registry\nDump: %s' % json_encoder.encode(obj))
def min_script(js):
"""
Minify script in a very insecure way.
"""
if js:
return js.replace("\n", " ")
#.replace(" ", " ") \
#.replace(" ", " ") \
#.replace(" ", " ") \
#.replace(" ", " ") \
#.replace(" ", " ") \
#.replace(" ", " ").replace("\t", " ")
return ""
================================================
FILE: setup.cfg
================================================
[metadata]
description_file = README.rst
================================================
FILE: setup.py
================================================
# -*- coding: utf-8 -*-
##############################################################################
#
# Mongotail, Log all MongoDB queries in a "tail"able way.
# Copyright (C) 2015-2022 Mariano Ruiz <https://github.com/mrsarm/mongotail>
#
# Author: Mariano Ruiz <mrsarm@gmail.com>
#
# 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 <http://www.gnu.org/licenses/>.
#
##############################################################################
from setuptools import setup
from os.path import abspath, dirname, join
from mongotail import __version__, __license__, __doc__, __url__
def read(*pathcomponents):
"""Read the contents of a file located relative to setup.py"""
with open(join(abspath(dirname(__file__)), *pathcomponents)) as thefile:
return thefile.read()
setup(
name = 'mongotail',
version=__version__,
license=__license__,
url=__url__,
download_url=__url__ + '/tarball/' + __version__,
author='Mariano Ruiz',
author_email='mrsarm@gmail.com',
description=__doc__,
long_description=read('README.rst'),
packages=[
'mongotail',
],
zip_safe=False,
platforms='any',
install_requires=[
'pymongo[srv]>=3.12,<5.0.0',
'res-address>=2.0.0,<3.0.0',
],
entry_points={
'console_scripts': [
'mongotail = mongotail.mongotail:main',
],
},
classifiers=[
'Development Status :: 5 - Production/Stable',
'Environment :: Console',
'Intended Audience :: Developers',
'Intended Audience :: System Administrators',
'Topic :: Database',
'Topic :: Utilities',
'Topic :: Terminals',
'License :: Public Domain',
'License :: OSI Approved :: GNU General Public License (GPL)',
'Operating System :: OS Independent',
'Programming Language :: Python',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
],
)
gitextract_t776byha/ ├── .github/ │ └── workflows/ │ └── python-app.yml ├── .gitignore ├── AUTHORS.rst ├── CHANGELOG.rst ├── COPYING ├── Dockerfile ├── INSTALL.rst ├── MANIFEST.in ├── Makefile ├── README.rst ├── mongotail/ │ ├── __init__.py │ ├── conn.py │ ├── err.py │ ├── jsondec.py │ ├── mongotail.py │ └── out.py ├── setup.cfg └── setup.py
SYMBOL INDEX (19 symbols across 6 files)
FILE: mongotail/conn.py
function connect (line 31) | def connect(address, args):
FILE: mongotail/err.py
function warn (line 29) | def warn(msg):
function error (line 34) | def error(msg, exit_code):
function error_parsing (line 43) | def error_parsing(msg="unknown options"):
function error_unknown (line 52) | def error_unknown():
FILE: mongotail/jsondec.py
class JSONEncoder (line 36) | class JSONEncoder(json.JSONEncoder):
method default (line 37) | def default(self, o):
method encode (line 63) | def encode(self, o):
method encode_number (line 89) | def encode_number(self, num):
FILE: mongotail/mongotail.py
function tail (line 59) | def tail(client, db, lines, follow, verbose, metadata):
function show_profiling_level (line 85) | def show_profiling_level(client, db):
function set_profiling_level (line 93) | def set_profiling_level(client, db, level):
function set_slowms_level (line 102) | def set_slowms_level(client, db, slowms):
function show_slowms_level (line 111) | def show_slowms_level(client, db):
function show_server_info (line 119) | def show_server_info(client, db):
function main (line 151) | def main():
FILE: mongotail/out.py
function print_obj (line 35) | def print_obj(obj, verbose, metadata, mongo_version):
function min_script (line 206) | def min_script(js):
FILE: setup.py
function read (line 30) | def read(*pathcomponents):
Condensed preview — 18 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (99K chars).
[
{
"path": ".github/workflows/python-app.yml",
"chars": 880,
"preview": "# This workflow will install Python dependencies, run tests and lint with a single version of Python\n# For more informat"
},
{
"path": ".gitignore",
"chars": 272,
"preview": "# Ignore byte compiled files\n*.py[co]\nbuild\ndist\n*.egg-info\n\n# Ignore Eclipse IDE files\n.settings\n.project\n.pydevproject"
},
{
"path": "AUTHORS.rst",
"chars": 993,
"preview": "AUTHORS\n=======\n\nMongotail was originally created and currently maintained by:\n\n* Mariano Ruiz <mrsarm@gmail.com>\n\n\nCONT"
},
{
"path": "CHANGELOG.rst",
"chars": 4473,
"preview": "Mongotail changelog\n===================\n\n\n3.1.1\n-----\n\n* Recognize and support alternate casings of ``findAndModify`` an"
},
{
"path": "COPYING",
"chars": 35147,
"preview": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free "
},
{
"path": "Dockerfile",
"chars": 371,
"preview": "# Dockerfile to generate a stable image version\n# of mongotail: https://hub.docker.com/r/mrsarm/mongotail\n#\n# Run with: "
},
{
"path": "INSTALL.rst",
"chars": 958,
"preview": "Installing mongotail\n====================\n\nPrerequisites\n-------------\n\n* Python 3.5+ or 2.7 (only tested with 2.7, 3.5,"
},
{
"path": "MANIFEST.in",
"chars": 97,
"preview": "include COPYING\ninclude README.rst\ninclude INSTALL.rst\ninclude CHANGELOG.rst\ninclude AUTHORS.rst\n"
},
{
"path": "Makefile",
"chars": 2844,
"preview": ".PHONY: clean install install-dev uninstall check-mongotail-version build upload upload-test \\\n install-from-pypi"
},
{
"path": "README.rst",
"chars": 11368,
"preview": "Mongotail\n=========\n\n.. image:: docs/images/mongotail-console.png\n\nMongotail, Log all `MongoDB <https://www.mongodb.com/"
},
{
"path": "mongotail/__init__.py",
"chars": 1947,
"preview": "# -*- coding: utf-8 -*-\n##############################################################################\n#\n# Mongotail, L"
},
{
"path": "mongotail/conn.py",
"chars": 3481,
"preview": "# -*- coding: utf-8 -*-\n##############################################################################\n#\n# Mongotail, L"
},
{
"path": "mongotail/err.py",
"chars": 1889,
"preview": "# -*- coding: utf-8 -*-\n##############################################################################\n#\n# Mongotail, L"
},
{
"path": "mongotail/jsondec.py",
"chars": 4029,
"preview": "# -*- coding: utf-8 -*-\n##############################################################################\n#\n# Mongotail, L"
},
{
"path": "mongotail/mongotail.py",
"chars": 12237,
"preview": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n##########################################################################"
},
{
"path": "mongotail/out.py",
"chars": 11046,
"preview": "# -*- coding: utf-8 -*-\n##############################################################################\n#\n# Mongotail, L"
},
{
"path": "setup.cfg",
"chars": 41,
"preview": "[metadata]\ndescription_file = README.rst\n"
},
{
"path": "setup.py",
"chars": 2784,
"preview": "# -*- coding: utf-8 -*-\n##############################################################################\n#\n# Mongotail, L"
}
]
About this extraction
This page contains the full source code of the mrsarm/mongotail GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 18 files (92.6 KB), approximately 21.5k tokens, and a symbol index with 19 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.