From dba0e6251015b4d27049f42ec4209d4f4ab76f14 Mon Sep 17 00:00:00 2001 From: Mya Pitzeruse Date: Tue, 1 Nov 2022 11:21:43 -0500 Subject: [PATCH] initial implementation --- .gitignore | 6 + AUTHORS | 10 + LICENSE | 663 ++++++++++++++++++++++++++++++ Makefile | 21 + README.md | 78 ++++ api.go | 78 ++++ api_impl.go | 77 ++++ client.go | 192 +++++++++ cmd/okit-sink/README.md | 3 + cmd/okit-sink/main.go | 5 + cmd/okitd/README.md | 6 + cmd/okitd/main.go | 5 + doc.go | 17 + examples/overview/main.go | 62 +++ go.mod | 8 + go.sum | 11 + legal/header.txt | 15 + pb/doc.go | 19 + pb/obkit.pb.go | 828 ++++++++++++++++++++++++++++++++++++++ pb/obkit.pbext.go | 42 ++ pb/obkit.proto | 100 +++++ tags.go | 135 +++++++ 22 files changed, 2381 insertions(+) create mode 100644 .gitignore create mode 100644 AUTHORS create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100644 api.go create mode 100644 api_impl.go create mode 100644 client.go create mode 100644 cmd/okit-sink/README.md create mode 100644 cmd/okit-sink/main.go create mode 100644 cmd/okitd/README.md create mode 100644 cmd/okitd/main.go create mode 100644 doc.go create mode 100644 examples/overview/main.go create mode 100644 go.mod create mode 100644 go.sum create mode 100644 legal/header.txt create mode 100644 pb/doc.go create mode 100644 pb/obkit.pb.go create mode 100644 pb/obkit.pbext.go create mode 100644 pb/obkit.proto create mode 100644 tags.go diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..042d98a --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ + + + + + + diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..f36675e --- /dev/null +++ b/AUTHORS @@ -0,0 +1,10 @@ +# This is the list of obkit's significant contributors. +# +# This does not necessarily list everyone who has contributed code, +# especially since many employees of one corporation may be contributing. +# To see the full list of contributors, see the revision history in +# source control. +# +# Format: +# name +# diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d7b8614 --- /dev/null +++ b/LICENSE @@ -0,0 +1,663 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + + Copyright (C) {{ year }} {{ organization }} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..06cd2d8 --- /dev/null +++ b/Makefile @@ -0,0 +1,21 @@ +CWD = $(shell pwd) + +define HELP_TEXT +Welcome to obkit! + +Targets: + help provides help text + test run tests + legal prepends legal header to source code + +endef +export HELP_TEXT + +help: + @echo "$$HELP_TEXT" + +# actual targets + +legal: .legal +.legal: + addlicense -f ./legal/header.txt -skip yaml -skip yml . diff --git a/README.md b/README.md new file mode 100644 index 0000000..2aab224 --- /dev/null +++ b/README.md @@ -0,0 +1,78 @@ +# okit + +Short for "observability kit", `okit` aims to provide an all-in-one solution to application observability. + +### Why + +Traditional approaches to observability treat logging, application metrics, and tracing as independent operations, with +independent data streams. In practice, these elements are more or less all the same, with some minor differences between +them. Developers often have to choose between logging a message, emitting a metric, or expanding a trace. + +**Logging** + + - Used by developers and operators to determine what issues an application may be facing. + - High cardinality data (errors, stack traces, user id / signature). + - Often sent to stdout/stderr and can optionally be captured by traditional logging solutions. + +**Tracing** + + - Used by developers and operators to troubleshoot performance issues across a set of distributed systems. + - Medium cardinality data (consistent structure, high variability in tag values) + - Typically available in real-time to assess product performance. + +**Metrics** + + - Used by developers and product managers to determine details about how their product is doing. + - Medium/High cardinality data (user id / signature, other metadata fields). + - Typically available in real-time to assess user experience / feature performance. + +### How + +```go +package main + +import ( + "context" + "os/signal" + "syscall" + "time" + + "go.pitz.tech/okit" +) + +var tags []okit.Tag + +func do(ctx context.Context) { + ctx, done := okit.With(tags...).Trace(ctx) + defer done() + + // DO WORK! + select { + case <-ctx.Done(): + case <-time.After(time.Second): + } +} + +func main() { + ctx, shutdown := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM) + defer shutdown() + + // Metric emission + okit.Observe("", 0, tags...) + + // Multi-dimensional events + okit.Emit("", tags...) + + // Tracing + ctx, done := okit.Trace(context.Background()) + defer done() + + // Logging + okit.Debug("", tags...) + okit.Info("", tags...) + okit.Warn("", tags...) + okit.Error("", tags...) + + do(ctx) +} +``` diff --git a/api.go b/api.go new file mode 100644 index 0000000..d1bada3 --- /dev/null +++ b/api.go @@ -0,0 +1,78 @@ +// Copyright (C) 2022 Mya Pitzeruse +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +package okit + +import ( + "context" +) + +// Logger defines common operations for writing log messages. +type Logger interface { + // Debug adds a debug message to the event stream, if configured. + Debug(msg string, tags ...Tag) + // Info adds an informational message to the event stream. + Info(msg string, tags ...Tag) + // Warn adds a warning to the event stream. + Warn(msg string, tags ...Tag) + // Error adds an error to the event stream. + Error(msg string, tags ...Tag) +} + +// Emitter is used to send multidimensional events to the underlying stream. +type Emitter interface { + // Emit sends the named event along the underlying stream. + Emit(event string, tags ...Tag) +} + +// Observer allows metrics to be captured and emit from the system. +type Observer interface { + // Observe records the associated metric and value. + Observe(metric string, value float64, tags ...Tag) +} + +// DoneFunc represents a function that is called when a trace is complete. +type DoneFunc func() + +// Tracer allows method calls to be instrumented for debugging. +type Tracer interface { + // Trace captures the method calling context and returns a function that can be invoked to complete the trace. + Trace(ctx context.Context, tags ...Tag) (context.Context, DoneFunc) +} + +// Span defines an internal structure for tracking traces across an application. This structure is only used for +// tracking purposes and direct modifications will not be reflected. +type Span struct { + // TraceID specifies an identifier for the overall trace event. This value is often inherited from a parent. + TraceID string + // ID uniquely identifies a span within a trace. + ID string + // ParentID points to the id of the wrapping span. + ParentID string +} + +type Wither[T any] interface { + With(tags ...Tag) T +} + +// Interface defines an abstraction that contains all the user-facing functions. +type Interface[T any] interface { + Logger + Emitter + Observer + Tracer + Wither[T] +} diff --git a/api_impl.go b/api_impl.go new file mode 100644 index 0000000..28e4e8f --- /dev/null +++ b/api_impl.go @@ -0,0 +1,77 @@ +// Copyright (C) 2022 Mya Pitzeruse +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +package okit + +import ( + "context" + "crypto/rand" + "encoding/base64" + "io" + "time" +) + +// contextKey is a holder structure that allows data to be attached to contexts. +type contextKey string + +// spanKey identifies a span on a given context. +var spanKey = contextKey("okit.span") + +// TODO: allow this to be replaced +var defaultClient Interface[Client] = Client{ + now: time.Now, + uuid: func() string { + buf := make([]byte, 16) + n, err := io.ReadFull(rand.Reader, buf) + if err != nil { + panic(err) + } + + return base64.RawStdEncoding.EncodeToString(buf[:n]) + }, +} + +func With(tags ...Tag) Client { + return defaultClient.With(tags...) +} + +func Emit(event string, tags ...Tag) { + defaultClient.Emit(event, tags...) +} + +func Observe(metric string, value float64, tags ...Tag) { + defaultClient.Observe(metric, value, tags...) +} + +func Trace(ctx context.Context, tags ...Tag) (context.Context, DoneFunc) { + return defaultClient.Trace(ctx, tags...) +} + +func Debug(msg string, tags ...Tag) { + defaultClient.Debug(msg, tags...) +} + +func Info(msg string, tags ...Tag) { + defaultClient.Info(msg, tags...) +} + +func Warn(msg string, tags ...Tag) { + defaultClient.Warn(msg, tags...) +} + +func Error(msg string, tags ...Tag) { + defaultClient.Error(msg, tags...) +} diff --git a/client.go b/client.go new file mode 100644 index 0000000..571645c --- /dev/null +++ b/client.go @@ -0,0 +1,192 @@ +// Copyright (C) 2022 Mya Pitzeruse +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +package okit + +import ( + "context" + "runtime" + "strings" + "time" + + "go.pitz.tech/okit/pb" +) + +// Client provides a default implementation. +type Client struct { + now func() time.Time + uuid func() string + tags []Tag +} + +func (o Client) withCaller() Client { + pkg, fn, line := infer(caller(3)) + + o.tags = append(o.tags, + String("package", pkg), + String("func", fn), + Int("line", line), + ) + + return o +} + +// With adds additional tags to the observer instance and returns a new copy for reference. +func (o Client) With(tags ...Tag) Client { + o.tags = append(o.tags, tags...) + + return o +} + +// Emit allows for the emission of an event which has now value and only associated tags. +func (o Client) Emit(event string, tags ...Tag) { + o.withCaller().With(tags...).emit(&pb.Entry{ + Kind: pb.Kind_Event, + Name: event, + }) +} + +// Observe reports a metric and it's associated value. +func (o Client) Observe(metric string, value float64, tags ...Tag) { + o.withCaller().With(tags...).emit(&pb.Entry{ + Value: &pb.Entry_Double{Double: value}, + Kind: pb.Kind_Metric, + Name: metric, + }) +} + +// Trace allows a method to be traced, and it's execution time recorded and reported for viewing. +func (o Client) Trace(ctx context.Context, tags ...Tag) (context.Context, DoneFunc) { + pkg, fn, _ := infer(caller(2)) + name := pkg + "." + fn + + start := o.now() + + span := Span{ + TraceID: o.uuid(), + ID: o.uuid(), + } + + v := ctx.Value(spanKey) + if v != nil { + parent, hasParent := v.(Span) + if hasParent { + span.TraceID = parent.TraceID + span.ParentID = parent.ID + } + } + + return context.WithValue(ctx, spanKey, span), func() { + duration := o.now().Sub(start) + + tags = append( + []Tag{ + String("trace-id", span.TraceID), + String("trace-span-id", span.ID), + String("trace-parent-id", span.ParentID), + }, + tags..., + ) + + o.withCaller().With(tags...).emit(&pb.Entry{ + Kind: pb.Kind_Trace, + Name: name, + Value: &pb.Entry_Duration{Duration: pb.DurationPB(duration)}, + }) + } +} + +// Debug produces a debug log event. +func (o Client) Debug(msg string, tags ...Tag) { + // todo: is debug enabled? + + o.withCaller().With(tags...).emit(&pb.Entry{ + Kind: pb.Kind_Log, + Name: msg, + Value: &pb.Entry_String_{String_: "debug"}, + }) +} + +// Info produces an information log event. +func (o Client) Info(msg string, tags ...Tag) { + // todo: is info enabled? + + o.withCaller().With(tags...).emit(&pb.Entry{ + Kind: pb.Kind_Log, + Name: msg, + Value: &pb.Entry_String_{String_: "info"}, + }) +} + +// Warn produces a warning that is surfaced to operators. +func (o Client) Warn(msg string, tags ...Tag) { + o.withCaller().With(tags...).emit(&pb.Entry{ + Kind: pb.Kind_Log, + Name: msg, + Value: &pb.Entry_String_{String_: "warn"}, + }) +} + +// Error produces a message that communicates an error has occurred. +func (o Client) Error(msg string, tags ...Tag) { + o.withCaller().With(tags...).emit(&pb.Entry{ + Kind: pb.Kind_Log, + Name: msg, + Value: &pb.Entry_String_{String_: "error"}, + }) +} + +func (o Client) emit(entry *pb.Entry) { + for _, tag := range o.tags { + if tagpb := tag.AsTagPB(); tagpb != nil { + entry.Tags = append(entry.Tags, tagpb) + } + } + + // todo: send to sinks +} + +// max returns the largest number in a series. +func max(series ...int) int { + largest := 0 + + for _, v := range series { + if v > largest { + largest = v + } + } + + return largest +} + +// caller attempts to get method caller information. This information is used for tracing information across an +// applications source code. +func caller(skip int) (name string, line int) { + pctr, _, line, ok := runtime.Caller(skip) + if !ok { + return "", 0 + } + + return runtime.FuncForPC(pctr).Name(), line +} + +// infer attempts to determine the calling package and function using runtime information. +func infer(name string, line int) (pkg, fn string, l int) { + lastSlash := max(0, strings.LastIndexByte(name, '/')) + lastDot := lastSlash + strings.LastIndexByte(name[lastSlash:], '.') + + return name[:lastDot], name[lastDot+1:], line +} diff --git a/cmd/okit-sink/README.md b/cmd/okit-sink/README.md new file mode 100644 index 0000000..e2cbb54 --- /dev/null +++ b/cmd/okit-sink/README.md @@ -0,0 +1,3 @@ +# okit-sink + +`okit-sink` is a server process that can receive okit packets directly and pass them off to a storage/indexing solution. diff --git a/cmd/okit-sink/main.go b/cmd/okit-sink/main.go new file mode 100644 index 0000000..0db886e --- /dev/null +++ b/cmd/okit-sink/main.go @@ -0,0 +1,5 @@ +package main + +func main() { + // TODO +} diff --git a/cmd/okitd/README.md b/cmd/okitd/README.md new file mode 100644 index 0000000..2590ded --- /dev/null +++ b/cmd/okitd/README.md @@ -0,0 +1,6 @@ +# okitd + +`okitd` is a local co-process to an application emitting metrics. It allows an application that has been written using +common monitoring solutions to be converted into an okit compatible solution. It wraps and traps program execution so +that it's able to consume application logs (preferably JSON) and receive metrics emit via systems like prometheus, +DataDog, and Statsd. diff --git a/cmd/okitd/main.go b/cmd/okitd/main.go new file mode 100644 index 0000000..0db886e --- /dev/null +++ b/cmd/okitd/main.go @@ -0,0 +1,5 @@ +package main + +func main() { + // TODO +} diff --git a/doc.go b/doc.go new file mode 100644 index 0000000..cdd9f85 --- /dev/null +++ b/doc.go @@ -0,0 +1,17 @@ +// Copyright (C) 2022 Mya Pitzeruse +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +package okit diff --git a/examples/overview/main.go b/examples/overview/main.go new file mode 100644 index 0000000..1182f15 --- /dev/null +++ b/examples/overview/main.go @@ -0,0 +1,62 @@ +// Copyright (C) 2022 Mya Pitzeruse +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +package main + +import ( + "context" + "os/signal" + "syscall" + "time" + + "go.pitz.tech/okit" +) + +var tags []okit.Tag + +func do(ctx context.Context) { + ctx, done := okit.With(tags...).Trace(ctx) + defer done() + + // DO WORK! + select { + case <-ctx.Done(): + case <-time.After(time.Second): + } +} + +func main() { + ctx, shutdown := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM) + defer shutdown() + + // Metric emission + okit.Observe("", 0, tags...) + + // Multi-dimensional events + okit.Emit("", tags...) + + // Tracing + ctx, done := okit.Trace(context.Background()) + defer done() + + // Logging + okit.Debug("", tags...) + okit.Info("", tags...) + okit.Warn("", tags...) + okit.Error("", tags...) + + do(ctx) +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..589fc64 --- /dev/null +++ b/go.mod @@ -0,0 +1,8 @@ +module go.pitz.tech/okit + +go 1.19 + +require ( + github.com/golang/protobuf v1.5.2 + google.golang.org/protobuf v1.28.1 +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..f415d59 --- /dev/null +++ b/go.sum @@ -0,0 +1,11 @@ +github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= +github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw= +github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= +github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= +github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= +google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= +google.golang.org/protobuf v1.28.1 h1:d0NfwRgPtno5B1Wa6L2DAG+KivqkdutMf1UhdNx175w= +google.golang.org/protobuf v1.28.1/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= diff --git a/legal/header.txt b/legal/header.txt new file mode 100644 index 0000000..a08e220 --- /dev/null +++ b/legal/header.txt @@ -0,0 +1,15 @@ +Copyright (C) 2022 Mya Pitzeruse + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see . + diff --git a/pb/doc.go b/pb/doc.go new file mode 100644 index 0000000..4bda409 --- /dev/null +++ b/pb/doc.go @@ -0,0 +1,19 @@ +// Copyright (C) 2022 Mya Pitzeruse +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +package pb + +//go:generate protoc --go_out=paths=source_relative:. -I=. obkit.proto diff --git a/pb/obkit.pb.go b/pb/obkit.pb.go new file mode 100644 index 0000000..3deb369 --- /dev/null +++ b/pb/obkit.pb.go @@ -0,0 +1,828 @@ +// Copyright (C) 2022 Mya Pitzeruse +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +// Code generated by protoc-gen-go. DO NOT EDIT. +// versions: +// protoc-gen-go v1.25.0 +// protoc v3.19.4 +// source: obkit.proto + +package pb + +import ( + proto "github.com/golang/protobuf/proto" + protoreflect "google.golang.org/protobuf/reflect/protoreflect" + protoimpl "google.golang.org/protobuf/runtime/protoimpl" + reflect "reflect" + sync "sync" +) + +const ( + // Verify that this generated code is sufficiently up-to-date. + _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) + // Verify that runtime/protoimpl is sufficiently up-to-date. + _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) +) + +// This is a compile-time assertion that a sufficiently up-to-date version +// of the legacy proto package is being used. +const _ = proto.ProtoPackageIsVersion4 + +// Kind represents the various types of elements that we're collecting. +type Kind int32 + +const ( + Kind_Unknown Kind = 0 + Kind_Event Kind = 1 + Kind_Metric Kind = 2 + Kind_Trace Kind = 3 + Kind_Log Kind = 4 +) + +// Enum value maps for Kind. +var ( + Kind_name = map[int32]string{ + 0: "Unknown", + 1: "Event", + 2: "Metric", + 3: "Trace", + 4: "Log", + } + Kind_value = map[string]int32{ + "Unknown": 0, + "Event": 1, + "Metric": 2, + "Trace": 3, + "Log": 4, + } +) + +func (x Kind) Enum() *Kind { + p := new(Kind) + *p = x + return p +} + +func (x Kind) String() string { + return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x)) +} + +func (Kind) Descriptor() protoreflect.EnumDescriptor { + return file_obkit_proto_enumTypes[0].Descriptor() +} + +func (Kind) Type() protoreflect.EnumType { + return &file_obkit_proto_enumTypes[0] +} + +func (x Kind) Number() protoreflect.EnumNumber { + return protoreflect.EnumNumber(x) +} + +// Deprecated: Use Kind.Descriptor instead. +func (Kind) EnumDescriptor() ([]byte, []int) { + return file_obkit_proto_rawDescGZIP(), []int{0} +} + +// Duration provides a protocol local implementation of a duration. +type Duration struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + Nanos int64 `protobuf:"varint,1,opt,name=nanos,proto3" json:"nanos,omitempty"` +} + +func (x *Duration) Reset() { + *x = Duration{} + if protoimpl.UnsafeEnabled { + mi := &file_obkit_proto_msgTypes[0] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *Duration) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*Duration) ProtoMessage() {} + +func (x *Duration) ProtoReflect() protoreflect.Message { + mi := &file_obkit_proto_msgTypes[0] + if protoimpl.UnsafeEnabled && x != nil { + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + if ms.LoadMessageInfo() == nil { + ms.StoreMessageInfo(mi) + } + return ms + } + return mi.MessageOf(x) +} + +// Deprecated: Use Duration.ProtoReflect.Descriptor instead. +func (*Duration) Descriptor() ([]byte, []int) { + return file_obkit_proto_rawDescGZIP(), []int{0} +} + +func (x *Duration) GetNanos() int64 { + if x != nil { + return x.Nanos + } + return 0 +} + +// Timestamp provides a protocol local implementation of a timestamp. +type Timestamp struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + Seconds int64 `protobuf:"varint,1,opt,name=seconds,proto3" json:"seconds,omitempty"` + Nanos int32 `protobuf:"varint,2,opt,name=nanos,proto3" json:"nanos,omitempty"` +} + +func (x *Timestamp) Reset() { + *x = Timestamp{} + if protoimpl.UnsafeEnabled { + mi := &file_obkit_proto_msgTypes[1] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *Timestamp) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*Timestamp) ProtoMessage() {} + +func (x *Timestamp) ProtoReflect() protoreflect.Message { + mi := &file_obkit_proto_msgTypes[1] + if protoimpl.UnsafeEnabled && x != nil { + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + if ms.LoadMessageInfo() == nil { + ms.StoreMessageInfo(mi) + } + return ms + } + return mi.MessageOf(x) +} + +// Deprecated: Use Timestamp.ProtoReflect.Descriptor instead. +func (*Timestamp) Descriptor() ([]byte, []int) { + return file_obkit_proto_rawDescGZIP(), []int{1} +} + +func (x *Timestamp) GetSeconds() int64 { + if x != nil { + return x.Seconds + } + return 0 +} + +func (x *Timestamp) GetNanos() int32 { + if x != nil { + return x.Nanos + } + return 0 +} + +// Tag defines a key-value element eligible for indexing. +type Tag struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` + // Types that are assignable to Value: + // *Tag_String_ + // *Tag_Int64 + // *Tag_Double + // *Tag_Bytes + // *Tag_Bool + // *Tag_Duration + // *Tag_Timestamp + Value isTag_Value `protobuf_oneof:"value"` +} + +func (x *Tag) Reset() { + *x = Tag{} + if protoimpl.UnsafeEnabled { + mi := &file_obkit_proto_msgTypes[2] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *Tag) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*Tag) ProtoMessage() {} + +func (x *Tag) ProtoReflect() protoreflect.Message { + mi := &file_obkit_proto_msgTypes[2] + if protoimpl.UnsafeEnabled && x != nil { + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + if ms.LoadMessageInfo() == nil { + ms.StoreMessageInfo(mi) + } + return ms + } + return mi.MessageOf(x) +} + +// Deprecated: Use Tag.ProtoReflect.Descriptor instead. +func (*Tag) Descriptor() ([]byte, []int) { + return file_obkit_proto_rawDescGZIP(), []int{2} +} + +func (x *Tag) GetKey() string { + if x != nil { + return x.Key + } + return "" +} + +func (m *Tag) GetValue() isTag_Value { + if m != nil { + return m.Value + } + return nil +} + +func (x *Tag) GetString_() string { + if x, ok := x.GetValue().(*Tag_String_); ok { + return x.String_ + } + return "" +} + +func (x *Tag) GetInt64() int64 { + if x, ok := x.GetValue().(*Tag_Int64); ok { + return x.Int64 + } + return 0 +} + +func (x *Tag) GetDouble() float64 { + if x, ok := x.GetValue().(*Tag_Double); ok { + return x.Double + } + return 0 +} + +func (x *Tag) GetBytes() []byte { + if x, ok := x.GetValue().(*Tag_Bytes); ok { + return x.Bytes + } + return nil +} + +func (x *Tag) GetBool() bool { + if x, ok := x.GetValue().(*Tag_Bool); ok { + return x.Bool + } + return false +} + +func (x *Tag) GetDuration() *Duration { + if x, ok := x.GetValue().(*Tag_Duration); ok { + return x.Duration + } + return nil +} + +func (x *Tag) GetTimestamp() *Timestamp { + if x, ok := x.GetValue().(*Tag_Timestamp); ok { + return x.Timestamp + } + return nil +} + +type isTag_Value interface { + isTag_Value() +} + +type Tag_String_ struct { + String_ string `protobuf:"bytes,5,opt,name=string,proto3,oneof"` +} + +type Tag_Int64 struct { + Int64 int64 `protobuf:"varint,6,opt,name=int64,proto3,oneof"` +} + +type Tag_Double struct { + Double float64 `protobuf:"fixed64,7,opt,name=double,proto3,oneof"` +} + +type Tag_Bytes struct { + Bytes []byte `protobuf:"bytes,8,opt,name=bytes,proto3,oneof"` +} + +type Tag_Bool struct { + Bool bool `protobuf:"varint,9,opt,name=bool,proto3,oneof"` +} + +type Tag_Duration struct { + Duration *Duration `protobuf:"bytes,10,opt,name=duration,proto3,oneof"` +} + +type Tag_Timestamp struct { + Timestamp *Timestamp `protobuf:"bytes,11,opt,name=timestamp,proto3,oneof"` +} + +func (*Tag_String_) isTag_Value() {} + +func (*Tag_Int64) isTag_Value() {} + +func (*Tag_Double) isTag_Value() {} + +func (*Tag_Bytes) isTag_Value() {} + +func (*Tag_Bool) isTag_Value() {} + +func (*Tag_Duration) isTag_Value() {} + +func (*Tag_Timestamp) isTag_Value() {} + +// Wire represents a common structure for communicating common observability elements. To help illustrate this, let us +// consider the following. +// +// - An Event is an Entry who's name is set and contains optional tags. +// - A Log is an Entry who's value is set to the verbosity of the message. +// - A Metric is an Event that has a value associated with the entry. +// - A Trace is a Metric whose tags have a specific structure that allow multiple to be correlated. +// +type Entry struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + // Timestamp defines when the entry was emit. This system assumes the client clock is accurate enough. + Timestamp *Timestamp `protobuf:"bytes,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"` + // Kind is used to indicate what type of entry this is. + Kind Kind `protobuf:"varint,3,opt,name=kind,proto3,enum=obkit.Kind" json:"kind,omitempty"` + // Name is used to identify the metric name, log message, or traced function. + Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"` + // Tags is an optional field that contains a list of metadata associated with the entry. + Tags []*Tag `protobuf:"bytes,5,rep,name=tags,proto3" json:"tags,omitempty"` + // Value is an optional field that defines a value associated with the entry (e.g. in the case of a log, metric, or trace). + // + // Types that are assignable to Value: + // *Entry_String_ + // *Entry_Double + // *Entry_Duration + Value isEntry_Value `protobuf_oneof:"value"` +} + +func (x *Entry) Reset() { + *x = Entry{} + if protoimpl.UnsafeEnabled { + mi := &file_obkit_proto_msgTypes[3] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *Entry) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*Entry) ProtoMessage() {} + +func (x *Entry) ProtoReflect() protoreflect.Message { + mi := &file_obkit_proto_msgTypes[3] + if protoimpl.UnsafeEnabled && x != nil { + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + if ms.LoadMessageInfo() == nil { + ms.StoreMessageInfo(mi) + } + return ms + } + return mi.MessageOf(x) +} + +// Deprecated: Use Entry.ProtoReflect.Descriptor instead. +func (*Entry) Descriptor() ([]byte, []int) { + return file_obkit_proto_rawDescGZIP(), []int{3} +} + +func (x *Entry) GetTimestamp() *Timestamp { + if x != nil { + return x.Timestamp + } + return nil +} + +func (x *Entry) GetKind() Kind { + if x != nil { + return x.Kind + } + return Kind_Unknown +} + +func (x *Entry) GetName() string { + if x != nil { + return x.Name + } + return "" +} + +func (x *Entry) GetTags() []*Tag { + if x != nil { + return x.Tags + } + return nil +} + +func (m *Entry) GetValue() isEntry_Value { + if m != nil { + return m.Value + } + return nil +} + +func (x *Entry) GetString_() string { + if x, ok := x.GetValue().(*Entry_String_); ok { + return x.String_ + } + return "" +} + +func (x *Entry) GetDouble() float64 { + if x, ok := x.GetValue().(*Entry_Double); ok { + return x.Double + } + return 0 +} + +func (x *Entry) GetDuration() *Duration { + if x, ok := x.GetValue().(*Entry_Duration); ok { + return x.Duration + } + return nil +} + +type isEntry_Value interface { + isEntry_Value() +} + +type Entry_String_ struct { + String_ string `protobuf:"bytes,6,opt,name=string,proto3,oneof"` // used for logs +} + +type Entry_Double struct { + Double float64 `protobuf:"fixed64,7,opt,name=double,proto3,oneof"` // used for metrics +} + +type Entry_Duration struct { + Duration *Duration `protobuf:"bytes,8,opt,name=duration,proto3,oneof"` // used for traces +} + +func (*Entry_String_) isEntry_Value() {} + +func (*Entry_Double) isEntry_Value() {} + +func (*Entry_Duration) isEntry_Value() {} + +// ClientInfo is used to capture specific information about the client application that is emitting information. +type ClientInfo struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` + Hostname string `protobuf:"bytes,2,opt,name=hostname,proto3" json:"hostname,omitempty"` +} + +func (x *ClientInfo) Reset() { + *x = ClientInfo{} + if protoimpl.UnsafeEnabled { + mi := &file_obkit_proto_msgTypes[4] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *ClientInfo) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*ClientInfo) ProtoMessage() {} + +func (x *ClientInfo) ProtoReflect() protoreflect.Message { + mi := &file_obkit_proto_msgTypes[4] + if protoimpl.UnsafeEnabled && x != nil { + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + if ms.LoadMessageInfo() == nil { + ms.StoreMessageInfo(mi) + } + return ms + } + return mi.MessageOf(x) +} + +// Deprecated: Use ClientInfo.ProtoReflect.Descriptor instead. +func (*ClientInfo) Descriptor() ([]byte, []int) { + return file_obkit_proto_rawDescGZIP(), []int{4} +} + +func (x *ClientInfo) GetName() string { + if x != nil { + return x.Name + } + return "" +} + +func (x *ClientInfo) GetHostname() string { + if x != nil { + return x.Hostname + } + return "" +} + +// Packet defines the set of data that is contained within each message sent to the server. +type Packet struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + // Client contains information that identifies the emitting client. + Client *ClientInfo `protobuf:"bytes,1,opt,name=client,proto3" json:"client,omitempty"` + // Entries are processed in batches, allowing local clients to buffer if necessary. + Entries []*Entry `protobuf:"bytes,2,rep,name=entries,proto3" json:"entries,omitempty"` +} + +func (x *Packet) Reset() { + *x = Packet{} + if protoimpl.UnsafeEnabled { + mi := &file_obkit_proto_msgTypes[5] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *Packet) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*Packet) ProtoMessage() {} + +func (x *Packet) ProtoReflect() protoreflect.Message { + mi := &file_obkit_proto_msgTypes[5] + if protoimpl.UnsafeEnabled && x != nil { + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + if ms.LoadMessageInfo() == nil { + ms.StoreMessageInfo(mi) + } + return ms + } + return mi.MessageOf(x) +} + +// Deprecated: Use Packet.ProtoReflect.Descriptor instead. +func (*Packet) Descriptor() ([]byte, []int) { + return file_obkit_proto_rawDescGZIP(), []int{5} +} + +func (x *Packet) GetClient() *ClientInfo { + if x != nil { + return x.Client + } + return nil +} + +func (x *Packet) GetEntries() []*Entry { + if x != nil { + return x.Entries + } + return nil +} + +var File_obkit_proto protoreflect.FileDescriptor + +var file_obkit_proto_rawDesc = []byte{ + 0x0a, 0x0b, 0x6f, 0x62, 0x6b, 0x69, 0x74, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x12, 0x05, 0x6f, + 0x62, 0x6b, 0x69, 0x74, 0x22, 0x20, 0x0a, 0x08, 0x44, 0x75, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, + 0x12, 0x14, 0x0a, 0x05, 0x6e, 0x61, 0x6e, 0x6f, 0x73, 0x18, 0x01, 0x20, 0x01, 0x28, 0x03, 0x52, + 0x05, 0x6e, 0x61, 0x6e, 0x6f, 0x73, 0x22, 0x3b, 0x0a, 0x09, 0x54, 0x69, 0x6d, 0x65, 0x73, 0x74, + 0x61, 0x6d, 0x70, 0x12, 0x18, 0x0a, 0x07, 0x73, 0x65, 0x63, 0x6f, 0x6e, 0x64, 0x73, 0x18, 0x01, + 0x20, 0x01, 0x28, 0x03, 0x52, 0x07, 0x73, 0x65, 0x63, 0x6f, 0x6e, 0x64, 0x73, 0x12, 0x14, 0x0a, + 0x05, 0x6e, 0x61, 0x6e, 0x6f, 0x73, 0x18, 0x02, 0x20, 0x01, 0x28, 0x05, 0x52, 0x05, 0x6e, 0x61, + 0x6e, 0x6f, 0x73, 0x22, 0xfb, 0x01, 0x0a, 0x03, 0x54, 0x61, 0x67, 0x12, 0x10, 0x0a, 0x03, 0x6b, + 0x65, 0x79, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x03, 0x6b, 0x65, 0x79, 0x12, 0x18, 0x0a, + 0x06, 0x73, 0x74, 0x72, 0x69, 0x6e, 0x67, 0x18, 0x05, 0x20, 0x01, 0x28, 0x09, 0x48, 0x00, 0x52, + 0x06, 0x73, 0x74, 0x72, 0x69, 0x6e, 0x67, 0x12, 0x16, 0x0a, 0x05, 0x69, 0x6e, 0x74, 0x36, 0x34, + 0x18, 0x06, 0x20, 0x01, 0x28, 0x03, 0x48, 0x00, 0x52, 0x05, 0x69, 0x6e, 0x74, 0x36, 0x34, 0x12, + 0x18, 0x0a, 0x06, 0x64, 0x6f, 0x75, 0x62, 0x6c, 0x65, 0x18, 0x07, 0x20, 0x01, 0x28, 0x01, 0x48, + 0x00, 0x52, 0x06, 0x64, 0x6f, 0x75, 0x62, 0x6c, 0x65, 0x12, 0x16, 0x0a, 0x05, 0x62, 0x79, 0x74, + 0x65, 0x73, 0x18, 0x08, 0x20, 0x01, 0x28, 0x0c, 0x48, 0x00, 0x52, 0x05, 0x62, 0x79, 0x74, 0x65, + 0x73, 0x12, 0x14, 0x0a, 0x04, 0x62, 0x6f, 0x6f, 0x6c, 0x18, 0x09, 0x20, 0x01, 0x28, 0x08, 0x48, + 0x00, 0x52, 0x04, 0x62, 0x6f, 0x6f, 0x6c, 0x12, 0x2d, 0x0a, 0x08, 0x64, 0x75, 0x72, 0x61, 0x74, + 0x69, 0x6f, 0x6e, 0x18, 0x0a, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0f, 0x2e, 0x6f, 0x62, 0x6b, 0x69, + 0x74, 0x2e, 0x44, 0x75, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x48, 0x00, 0x52, 0x08, 0x64, 0x75, + 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x12, 0x30, 0x0a, 0x09, 0x74, 0x69, 0x6d, 0x65, 0x73, 0x74, + 0x61, 0x6d, 0x70, 0x18, 0x0b, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x10, 0x2e, 0x6f, 0x62, 0x6b, 0x69, + 0x74, 0x2e, 0x54, 0x69, 0x6d, 0x65, 0x73, 0x74, 0x61, 0x6d, 0x70, 0x48, 0x00, 0x52, 0x09, 0x74, + 0x69, 0x6d, 0x65, 0x73, 0x74, 0x61, 0x6d, 0x70, 0x42, 0x07, 0x0a, 0x05, 0x76, 0x61, 0x6c, 0x75, + 0x65, 0x22, 0xf8, 0x01, 0x0a, 0x05, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x12, 0x2e, 0x0a, 0x09, 0x74, + 0x69, 0x6d, 0x65, 0x73, 0x74, 0x61, 0x6d, 0x70, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x10, + 0x2e, 0x6f, 0x62, 0x6b, 0x69, 0x74, 0x2e, 0x54, 0x69, 0x6d, 0x65, 0x73, 0x74, 0x61, 0x6d, 0x70, + 0x52, 0x09, 0x74, 0x69, 0x6d, 0x65, 0x73, 0x74, 0x61, 0x6d, 0x70, 0x12, 0x1f, 0x0a, 0x04, 0x6b, + 0x69, 0x6e, 0x64, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x0b, 0x2e, 0x6f, 0x62, 0x6b, 0x69, + 0x74, 0x2e, 0x4b, 0x69, 0x6e, 0x64, 0x52, 0x04, 0x6b, 0x69, 0x6e, 0x64, 0x12, 0x12, 0x0a, 0x04, + 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x04, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, + 0x12, 0x1e, 0x0a, 0x04, 0x74, 0x61, 0x67, 0x73, 0x18, 0x05, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x0a, + 0x2e, 0x6f, 0x62, 0x6b, 0x69, 0x74, 0x2e, 0x54, 0x61, 0x67, 0x52, 0x04, 0x74, 0x61, 0x67, 0x73, + 0x12, 0x18, 0x0a, 0x06, 0x73, 0x74, 0x72, 0x69, 0x6e, 0x67, 0x18, 0x06, 0x20, 0x01, 0x28, 0x09, + 0x48, 0x00, 0x52, 0x06, 0x73, 0x74, 0x72, 0x69, 0x6e, 0x67, 0x12, 0x18, 0x0a, 0x06, 0x64, 0x6f, + 0x75, 0x62, 0x6c, 0x65, 0x18, 0x07, 0x20, 0x01, 0x28, 0x01, 0x48, 0x00, 0x52, 0x06, 0x64, 0x6f, + 0x75, 0x62, 0x6c, 0x65, 0x12, 0x2d, 0x0a, 0x08, 0x64, 0x75, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, + 0x18, 0x08, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0f, 0x2e, 0x6f, 0x62, 0x6b, 0x69, 0x74, 0x2e, 0x44, + 0x75, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x48, 0x00, 0x52, 0x08, 0x64, 0x75, 0x72, 0x61, 0x74, + 0x69, 0x6f, 0x6e, 0x42, 0x07, 0x0a, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x22, 0x3c, 0x0a, 0x0a, + 0x43, 0x6c, 0x69, 0x65, 0x6e, 0x74, 0x49, 0x6e, 0x66, 0x6f, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, + 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x1a, + 0x0a, 0x08, 0x68, 0x6f, 0x73, 0x74, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, + 0x52, 0x08, 0x68, 0x6f, 0x73, 0x74, 0x6e, 0x61, 0x6d, 0x65, 0x22, 0x5b, 0x0a, 0x06, 0x50, 0x61, + 0x63, 0x6b, 0x65, 0x74, 0x12, 0x29, 0x0a, 0x06, 0x63, 0x6c, 0x69, 0x65, 0x6e, 0x74, 0x18, 0x01, + 0x20, 0x01, 0x28, 0x0b, 0x32, 0x11, 0x2e, 0x6f, 0x62, 0x6b, 0x69, 0x74, 0x2e, 0x43, 0x6c, 0x69, + 0x65, 0x6e, 0x74, 0x49, 0x6e, 0x66, 0x6f, 0x52, 0x06, 0x63, 0x6c, 0x69, 0x65, 0x6e, 0x74, 0x12, + 0x26, 0x0a, 0x07, 0x65, 0x6e, 0x74, 0x72, 0x69, 0x65, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, + 0x32, 0x0c, 0x2e, 0x6f, 0x62, 0x6b, 0x69, 0x74, 0x2e, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x52, 0x07, + 0x65, 0x6e, 0x74, 0x72, 0x69, 0x65, 0x73, 0x2a, 0x3e, 0x0a, 0x04, 0x4b, 0x69, 0x6e, 0x64, 0x12, + 0x0b, 0x0a, 0x07, 0x55, 0x6e, 0x6b, 0x6e, 0x6f, 0x77, 0x6e, 0x10, 0x00, 0x12, 0x09, 0x0a, 0x05, + 0x45, 0x76, 0x65, 0x6e, 0x74, 0x10, 0x01, 0x12, 0x0a, 0x0a, 0x06, 0x4d, 0x65, 0x74, 0x72, 0x69, + 0x63, 0x10, 0x02, 0x12, 0x09, 0x0a, 0x05, 0x54, 0x72, 0x61, 0x63, 0x65, 0x10, 0x03, 0x12, 0x07, + 0x0a, 0x03, 0x4c, 0x6f, 0x67, 0x10, 0x04, 0x42, 0x1c, 0x5a, 0x1a, 0x63, 0x6f, 0x64, 0x65, 0x2e, + 0x70, 0x69, 0x74, 0x7a, 0x2e, 0x74, 0x65, 0x63, 0x68, 0x2f, 0x6d, 0x79, 0x61, 0x2f, 0x6f, 0x6b, + 0x69, 0x74, 0x2f, 0x70, 0x62, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, +} + +var ( + file_obkit_proto_rawDescOnce sync.Once + file_obkit_proto_rawDescData = file_obkit_proto_rawDesc +) + +func file_obkit_proto_rawDescGZIP() []byte { + file_obkit_proto_rawDescOnce.Do(func() { + file_obkit_proto_rawDescData = protoimpl.X.CompressGZIP(file_obkit_proto_rawDescData) + }) + return file_obkit_proto_rawDescData +} + +var file_obkit_proto_enumTypes = make([]protoimpl.EnumInfo, 1) +var file_obkit_proto_msgTypes = make([]protoimpl.MessageInfo, 6) +var file_obkit_proto_goTypes = []interface{}{ + (Kind)(0), // 0: obkit.Kind + (*Duration)(nil), // 1: obkit.Duration + (*Timestamp)(nil), // 2: obkit.Timestamp + (*Tag)(nil), // 3: obkit.Tag + (*Entry)(nil), // 4: obkit.Entry + (*ClientInfo)(nil), // 5: obkit.ClientInfo + (*Packet)(nil), // 6: obkit.Packet +} +var file_obkit_proto_depIdxs = []int32{ + 1, // 0: obkit.Tag.duration:type_name -> obkit.Duration + 2, // 1: obkit.Tag.timestamp:type_name -> obkit.Timestamp + 2, // 2: obkit.Entry.timestamp:type_name -> obkit.Timestamp + 0, // 3: obkit.Entry.kind:type_name -> obkit.Kind + 3, // 4: obkit.Entry.tags:type_name -> obkit.Tag + 1, // 5: obkit.Entry.duration:type_name -> obkit.Duration + 5, // 6: obkit.Packet.client:type_name -> obkit.ClientInfo + 4, // 7: obkit.Packet.entries:type_name -> obkit.Entry + 8, // [8:8] is the sub-list for method output_type + 8, // [8:8] is the sub-list for method input_type + 8, // [8:8] is the sub-list for extension type_name + 8, // [8:8] is the sub-list for extension extendee + 0, // [0:8] is the sub-list for field type_name +} + +func init() { file_obkit_proto_init() } +func file_obkit_proto_init() { + if File_obkit_proto != nil { + return + } + if !protoimpl.UnsafeEnabled { + file_obkit_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*Duration); i { + case 0: + return &v.state + case 1: + return &v.sizeCache + case 2: + return &v.unknownFields + default: + return nil + } + } + file_obkit_proto_msgTypes[1].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*Timestamp); i { + case 0: + return &v.state + case 1: + return &v.sizeCache + case 2: + return &v.unknownFields + default: + return nil + } + } + file_obkit_proto_msgTypes[2].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*Tag); i { + case 0: + return &v.state + case 1: + return &v.sizeCache + case 2: + return &v.unknownFields + default: + return nil + } + } + file_obkit_proto_msgTypes[3].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*Entry); i { + case 0: + return &v.state + case 1: + return &v.sizeCache + case 2: + return &v.unknownFields + default: + return nil + } + } + file_obkit_proto_msgTypes[4].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*ClientInfo); i { + case 0: + return &v.state + case 1: + return &v.sizeCache + case 2: + return &v.unknownFields + default: + return nil + } + } + file_obkit_proto_msgTypes[5].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*Packet); i { + case 0: + return &v.state + case 1: + return &v.sizeCache + case 2: + return &v.unknownFields + default: + return nil + } + } + } + file_obkit_proto_msgTypes[2].OneofWrappers = []interface{}{ + (*Tag_String_)(nil), + (*Tag_Int64)(nil), + (*Tag_Double)(nil), + (*Tag_Bytes)(nil), + (*Tag_Bool)(nil), + (*Tag_Duration)(nil), + (*Tag_Timestamp)(nil), + } + file_obkit_proto_msgTypes[3].OneofWrappers = []interface{}{ + (*Entry_String_)(nil), + (*Entry_Double)(nil), + (*Entry_Duration)(nil), + } + type x struct{} + out := protoimpl.TypeBuilder{ + File: protoimpl.DescBuilder{ + GoPackagePath: reflect.TypeOf(x{}).PkgPath(), + RawDescriptor: file_obkit_proto_rawDesc, + NumEnums: 1, + NumMessages: 6, + NumExtensions: 0, + NumServices: 0, + }, + GoTypes: file_obkit_proto_goTypes, + DependencyIndexes: file_obkit_proto_depIdxs, + EnumInfos: file_obkit_proto_enumTypes, + MessageInfos: file_obkit_proto_msgTypes, + }.Build() + File_obkit_proto = out.File + file_obkit_proto_rawDesc = nil + file_obkit_proto_goTypes = nil + file_obkit_proto_depIdxs = nil +} diff --git a/pb/obkit.pbext.go b/pb/obkit.pbext.go new file mode 100644 index 0000000..8ea1be1 --- /dev/null +++ b/pb/obkit.pbext.go @@ -0,0 +1,42 @@ +// Copyright (C) 2022 Mya Pitzeruse +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +package pb + +import ( + "time" +) + +func (x *Duration) AsDuration() time.Duration { + return time.Duration(x.Nanos) +} + +func DurationPB(d time.Duration) *Duration { + return &Duration{ + Nanos: int64(d), + } +} + +func (x *Timestamp) AsTime() time.Time { + return time.Unix(x.Seconds, int64(x.Nanos)) +} + +func TimestampPB(t time.Time) *Timestamp { + return &Timestamp{ + Seconds: t.Unix(), + Nanos: int32(t.Nanosecond()), + } +} diff --git a/pb/obkit.proto b/pb/obkit.proto new file mode 100644 index 0000000..ca941b1 --- /dev/null +++ b/pb/obkit.proto @@ -0,0 +1,100 @@ +// Copyright (C) 2022 Mya Pitzeruse +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +syntax = "proto3"; + +package obkit; + +option go_package = "code.pitz.tech/mya/okit/pb"; + +// Duration provides a protocol local implementation of a duration. +message Duration { + int64 nanos = 1; +} + +// Timestamp provides a protocol local implementation of a timestamp. +message Timestamp { + int64 seconds = 1; + int32 nanos = 2; +} + +// Tag defines a key-value element eligible for indexing. +message Tag { + string key = 1; + + oneof value { + string string = 5; + int64 int64 = 6; + double double = 7; + bytes bytes = 8; + bool bool = 9; + Duration duration = 10; + Timestamp timestamp = 11; + } +} + +// Kind represents the various types of elements that we're collecting. +enum Kind { + Unknown = 0; + Event = 1; + Metric = 2; + Trace = 3; + Log = 4; +} + +// Wire represents a common structure for communicating common observability elements. To help illustrate this, let us +// consider the following. +// +// - An Event is an Entry who's name is set and contains optional tags. +// - A Log is an Entry who's value is set to the verbosity of the message. +// - A Metric is an Event that has a value associated with the entry. +// - A Trace is a Metric whose tags have a specific structure that allow multiple to be correlated. +// +message Entry { + // Timestamp defines when the entry was emit. This system assumes the client clock is accurate enough. + Timestamp timestamp = 1; + + // Kind is used to indicate what type of entry this is. + Kind kind = 3; + + // Name is used to identify the metric name, log message, or traced function. + string name = 4; + + // Tags is an optional field that contains a list of metadata associated with the entry. + repeated Tag tags = 5; + + // Value is an optional field that defines a value associated with the entry (e.g. in the case of a log, metric, or trace). + oneof value { + string string = 6; // used for logs + double double = 7; // used for metrics + Duration duration = 8; // used for traces + } +} + +// ClientInfo is used to capture specific information about the client application that is emitting information. +message ClientInfo { + string name = 1; + string hostname = 2; +} + +// Packet defines the set of data that is contained within each message sent to the server. +message Packet { + // Client contains information that identifies the emitting client. + ClientInfo client = 1; + + // Entries are processed in batches, allowing local clients to buffer if necessary. + repeated Entry entries = 2; +} diff --git a/tags.go b/tags.go new file mode 100644 index 0000000..a3bbb77 --- /dev/null +++ b/tags.go @@ -0,0 +1,135 @@ +// Copyright (C) 2022 Mya Pitzeruse +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +package okit + +import ( + "time" + + "go.pitz.tech/okit/pb" +) + +// Tag defines a generic data holder that allows values to be passed around during observation. Both raw values and +// pointers can be used, allowing data to be lazily read and pulled during emission. +type Tag struct { + key string + value interface{} +} + +// AsTagPB converts the tag to the proto tag for transport and reporting. +func (t Tag) AsTagPB() *pb.Tag { + if t.value == nil { + return nil + } + + switch v := t.value.(type) { + // values + case string: + return &pb.Tag{Key: t.key, Value: &pb.Tag_String_{String_: v}} + case int: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Int64{Int64: int64(v)}} + case int8: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Int64{Int64: int64(v)}} + case int16: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Int64{Int64: int64(v)}} + case int32: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Int64{Int64: int64(v)}} + case int64: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Int64{Int64: v}} + case float32: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Double{Double: float64(v)}} + case float64: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Double{Double: v}} + case []byte: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Bytes{Bytes: v}} + case bool: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Bool{Bool: v}} + case time.Duration: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Duration{Duration: pb.DurationPB(v)}} + case time.Time: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Timestamp{Timestamp: pb.TimestampPB(v)}} + + // pointers + case *string: + return &pb.Tag{Key: t.key, Value: &pb.Tag_String_{String_: *v}} + case *int: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Int64{Int64: int64(*v)}} + case *int8: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Int64{Int64: int64(*v)}} + case *int16: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Int64{Int64: int64(*v)}} + case *int32: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Int64{Int64: int64(*v)}} + case *int64: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Int64{Int64: *v}} + case *float32: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Double{Double: float64(*v)}} + case *float64: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Double{Double: *v}} + case *[]byte: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Bytes{Bytes: *v}} + case *bool: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Bool{Bool: *v}} + case *time.Duration: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Duration{Duration: pb.DurationPB(*v)}} + case *time.Time: + return &pb.Tag{Key: t.key, Value: &pb.Tag_Timestamp{Timestamp: pb.TimestampPB(*v)}} + } + + return nil +} + +func String(key, value string) Tag { return Tag{key, value} } +func Stringp(key string, value *string) Tag { return Tag{key, value} } + +func Int(key string, value int) Tag { return Tag{key, value} } +func Intp(key string, value *int) Tag { return Tag{key, value} } +func Int8(key string, value int8) Tag { return Tag{key, value} } +func Int8p(key string, value *int8) Tag { return Tag{key, value} } +func Int16(key string, value int16) Tag { return Tag{key, value} } +func Int16p(key string, value *int16) Tag { return Tag{key, value} } +func Int32(key string, value int32) Tag { return Tag{key, value} } +func Int32p(key string, value *int32) Tag { return Tag{key, value} } +func Int64(key string, value int64) Tag { return Tag{key, value} } +func Int64p(key string, value *int64) Tag { return Tag{key, value} } + +func Uint(key string, value uint) Tag { return Tag{key, value} } +func Uintp(key string, value *uint) Tag { return Tag{key, value} } +func Uint8(key string, value uint8) Tag { return Tag{key, value} } +func Uint8p(key string, value *uint8) Tag { return Tag{key, value} } +func Uint16(key string, value uint16) Tag { return Tag{key, value} } +func Uint16p(key string, value *uint16) Tag { return Tag{key, value} } +func Uint32(key string, value uint32) Tag { return Tag{key, value} } +func Uint32p(key string, value *uint32) Tag { return Tag{key, value} } +func Uint64(key string, value uint64) Tag { return Tag{key, value} } +func Uint64p(key string, value *uint64) Tag { return Tag{key, value} } + +func Float32(key string, value float32) Tag { return Tag{key, value} } +func Float32p(key string, value *float32) Tag { return Tag{key, value} } +func Float64(key string, value float64) Tag { return Tag{key, value} } +func Float64p(key string, value *float64) Tag { return Tag{key, value} } + +func Bytes(key string, value []byte) Tag { return Tag{key, value} } +func Bytesp(key string, value *[]byte) Tag { return Tag{key, value} } + +func Bool(key string, value bool) Tag { return Tag{key, value} } +func Boolp(key string, value *bool) Tag { return Tag{key, value} } + +func Duration(key string, value time.Duration) Tag { return Tag{key, value} } +func Durationp(key string, value *time.Duration) Tag { return Tag{key, value} } + +func Timestamp(key string, value time.Time) Tag { return Tag{key, value} } +func Timestampp(key string, value *time.Time) Tag { return Tag{key, value} }