diff --git a/cabal.project b/cabal.project index 96d20a6f06..0301456260 100644 --- a/cabal.project +++ b/cabal.project @@ -50,6 +50,7 @@ packages: , tools/fedcalls/ , tools/rex/ , tools/stern/ + , tools/mlsstats/ tests: True benchmarks: True @@ -114,6 +115,8 @@ package polysemy-wire-zoo ghc-options: -Werror package proxy ghc-options: -Werror +package mlsstats + ghc-options: -Werror package repair-handles ghc-options: -Werror package rex diff --git a/changelog.d/5-internal/mls-save-migration-statistics b/changelog.d/5-internal/mls-save-migration-statistics new file mode 100644 index 0000000000..c418bae204 --- /dev/null +++ b/changelog.d/5-internal/mls-save-migration-statistics @@ -0,0 +1,3 @@ +New cron job to save data usable to watch the progress of the Proteus to MLS migration in S3 bucket. + +**IMPORTANT:** This cron job is _not_ meant for general use! It can leak data about one team to other teams. diff --git a/charts/mlsstats/.helmignore b/charts/mlsstats/.helmignore new file mode 100644 index 0000000000..f0c1319444 --- /dev/null +++ b/charts/mlsstats/.helmignore @@ -0,0 +1,21 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj diff --git a/charts/mlsstats/Chart.yaml b/charts/mlsstats/Chart.yaml new file mode 100644 index 0000000000..24d97f8f2e --- /dev/null +++ b/charts/mlsstats/Chart.yaml @@ -0,0 +1,4 @@ +apiVersion: v1 +description: mlsstats - Push Proteus to MLS statistics to S3 +name: mlsstats +version: 0.0.1 diff --git a/charts/mlsstats/README.md b/charts/mlsstats/README.md new file mode 100644 index 0000000000..b9c8c11834 --- /dev/null +++ b/charts/mlsstats/README.md @@ -0,0 +1,7 @@ +# mlsstats + +The kubernetes cronjob resource will spawn a new `mlsstats-XXXXXX` pod every day. Logs for the pod can be gathered with `kubectl log`. + +## Important note + +This cron job is _not_ meant for general use! It can leak data about one team to other teams. diff --git a/charts/mlsstats/templates/_helpers.tpl b/charts/mlsstats/templates/_helpers.tpl new file mode 100644 index 0000000000..c288d2067d --- /dev/null +++ b/charts/mlsstats/templates/_helpers.tpl @@ -0,0 +1,13 @@ +{{/* Allow KubeVersion to be overridden. */}} +{{- define "kubeVersion" -}} + {{- default .Capabilities.KubeVersion.Version .Values.kubeVersionOverride -}} +{{- end -}} + +{{/* Get Batch API Version */}} +{{- define "batch.apiVersion" -}} + {{- if and (.Capabilities.APIVersions.Has "batch/v1") (semverCompare ">= 1.21-0" (include "kubeVersion" .)) -}} + {{- print "batch/v1" -}} + {{- else -}} + {{- print "batch/v1beta1" -}} + {{- end -}} +{{- end -}} diff --git a/charts/mlsstats/templates/cronjob.yaml b/charts/mlsstats/templates/cronjob.yaml new file mode 100644 index 0000000000..5247b15cd3 --- /dev/null +++ b/charts/mlsstats/templates/cronjob.yaml @@ -0,0 +1,60 @@ +apiVersion: {{ include "batch.apiVersion" . }} +kind: CronJob +metadata: + name: {{ .Release.Name }} + labels: + app: mlsstats + chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }} + release: {{ .Release.Name }} + heritage: {{ .Release.Service }} +spec: + concurrencyPolicy: Forbid + schedule: {{ .Values.schedule | quote }} + jobTemplate: + metadata: + labels: + app: mlsstats + release: {{ .Release.Name }} + annotations: + # An annotation of the configmap checksum ensures changes to the configmap cause a redeployment upon `helm upgrade` + checksum/secret: {{ include (print .Template.BasePath "/secret.yaml") . | sha256sum }} + spec: + backoffLimit: 0 + template: + spec: + restartPolicy: Never + containers: + - name: mlsstats + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" + imagePullPolicy: {{ default "" .Values.imagePullPolicy | quote }} + args: [ "mlsstats" + , "--brig-cassandra-host", {{ .Values.config.cassandra.brig.host | quote }} + , "--brig-cassandra-port", {{ .Values.config.cassandra.brig.port | quote }} + , "--brig-cassandra-keyspace", {{ .Values.config.cassandra.brig.keyspace | quote }} + , "--galley-cassandra-host", {{ .Values.config.cassandra.galley.host | quote }} + , "--galley-cassandra-port", {{ .Values.config.cassandra.galley.port | quote }} + , "--galley-cassandra-keyspace", {{ .Values.config.cassandra.galley.keyspace | quote }} + , "--cassandra-pagesize", {{ .Values.config.cassandra.pagesize | quote }} + , "--s3-endpoint", {{ .Values.config.s3.endpoint | quote -}} + , "--s3-region", {{ .Values.config.s3.region | quote -}} + , "--s3-addressing-style", {{ .Values.config.s3.addressingStyle | quote }} + , "--s3-bucket-name", {{ .Values.config.s3.bucket.name | quote }} + , "--s3-bucket-dir", {{ .Values.config.s3.bucket.directory | quote }} + ] + resources: + env: + {{- if hasKey .Values.secrets "awsKeyId" }} + - name: AWS_ACCESS_KEY_ID + valueFrom: + secretKeyRef: + name: mlsstats + key: awsKeyId + - name: AWS_SECRET_ACCESS_KEY + valueFrom: + secretKeyRef: + name: mlsstats + key: awsSecretKey + {{- end }} + - name: AWS_REGION + value: "{{ .Values.config.s3.region }}" +{{ toYaml .Values.resources | indent 16 }} diff --git a/charts/mlsstats/templates/secret.yaml b/charts/mlsstats/templates/secret.yaml new file mode 100644 index 0000000000..3f93be5120 --- /dev/null +++ b/charts/mlsstats/templates/secret.yaml @@ -0,0 +1,20 @@ +apiVersion: v1 +kind: Secret +metadata: + name: {{ .Release.Name }} + labels: + app: mlsstats + chart: "{{ .Chart.Name }}-{{ .Chart.Version }}" + release: "{{ .Release.Name }}" + heritage: "{{ .Release.Service }}" +type: Opaque +data: + {{/* for_helm_linting is necessary only since the 'with' block below does not throw an error upon an empty .Values.secrets */}} + for_helm_linting: {{ required "No .secrets found in configuration. Did you forget to helm -f path/to/secrets.yaml ?" .Values.secrets | quote | b64enc | quote }} + + {{- with .Values.secrets }} + {{- if .awsKeyId }} + awsKeyId: {{ .awsKeyId | b64enc | quote }} + awsSecretKey: {{ .awsSecretKey | b64enc | quote }} + {{- end }} + {{- end }} diff --git a/charts/mlsstats/values.yaml b/charts/mlsstats/values.yaml new file mode 100644 index 0000000000..399bc1ec99 --- /dev/null +++ b/charts/mlsstats/values.yaml @@ -0,0 +1,30 @@ +image: + repository: quay.io/wire/mlsstats + tag: 0.1 +resources: + requests: + memory: "256Mi" + cpu: "100m" + limits: + memory: "256Mi" + cpu: "100m" +schedule: "23 3 * * *" +config: + cassandra: + brig: + host: cassandra + port: 9042 + keyspace: brig + galley: + host: cassandra + port: 9042 + keyspace: galley + pagesize: 1024 + s3: + endpoint: https://s3.eu-west-1.amazonaws.com/ + region: eu-west-1 + addressingStyle: auto + bucket: + name: mlsstats + directory: "/" +secrets: {} diff --git a/charts/wire-server/requirements.yaml b/charts/wire-server/requirements.yaml index 9a2ff8649b..b5350be6c8 100644 --- a/charts/wire-server/requirements.yaml +++ b/charts/wire-server/requirements.yaml @@ -129,3 +129,8 @@ dependencies: repository: "file://../integration" tags: - integration +- name: mlsstats + version: "0.0.42" + repository: "file://../mlsstats" + tags: + - mlsstats diff --git a/charts/wire-server/values.yaml b/charts/wire-server/values.yaml index a2ba0c3a51..3a0a3f1f52 100644 --- a/charts/wire-server/values.yaml +++ b/charts/wire-server/values.yaml @@ -12,3 +12,4 @@ tags: federation: false # see also galley.config.enableFederation and brig.config.enableFederation sftd: false backoffice: false + mlsstats: false diff --git a/nix/local-haskell-packages.nix b/nix/local-haskell-packages.nix index f06c352c73..59d940f7cf 100644 --- a/nix/local-haskell-packages.nix +++ b/nix/local-haskell-packages.nix @@ -52,6 +52,7 @@ repair-handles = hself.callPackage ../tools/db/repair-handles/default.nix { inherit gitignoreSource; }; service-backfill = hself.callPackage ../tools/db/service-backfill/default.nix { inherit gitignoreSource; }; fedcalls = hself.callPackage ../tools/fedcalls/default.nix { inherit gitignoreSource; }; + mlsstats = hself.callPackage ../tools/mlsstats/default.nix { inherit gitignoreSource; }; rex = hself.callPackage ../tools/rex/default.nix { inherit gitignoreSource; }; stern = hself.callPackage ../tools/stern/default.nix { inherit gitignoreSource; }; } diff --git a/tools/mlsstats/.ormolu b/tools/mlsstats/.ormolu new file mode 120000 index 0000000000..157b212d7c --- /dev/null +++ b/tools/mlsstats/.ormolu @@ -0,0 +1 @@ +../../.ormolu \ No newline at end of file diff --git a/tools/mlsstats/LICENSE b/tools/mlsstats/LICENSE new file mode 100644 index 0000000000..dba13ed2dd --- /dev/null +++ b/tools/mlsstats/LICENSE @@ -0,0 +1,661 @@ + 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) + + 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/tools/mlsstats/README.md b/tools/mlsstats/README.md new file mode 100644 index 0000000000..f1ed814b00 --- /dev/null +++ b/tools/mlsstats/README.md @@ -0,0 +1,43 @@ +MLSStats - Data for monitoring Proteus to MLS migration +======================================================= + +MLSStats extracts the data relevant to an ongoing migration from Proteus to MLS and stores the data as four files to an S3 bucket, +- `user-client.csv`, +- `conv-group-team-protocol.csv`, +- `domain-user-client-group.csv`, and +- `user-conv.csv`. + +The tool is supposed to run (not more often than) once a day, preferably from a (Kubernetes) cron job. + +## Important note + +This cron job is _not_ meant for general use! It can leak data about one team to other teams. + +## How to interpret the data + +There are two tables with generic data from both protocols, `user-client.cvs` and `user-conv.cvs`, and two tables with MLS-specific data, `conv-group-team-protocol.csv` and `domain-user-client-group.csv`. In order to draw conclusions about the progress of the migration, the generic data has to be related to MLS-specific data. + + +### Use-case: conversation state ratio + +The protocol used in a conversation can be Proteus, Mixed, and MLS. Mixed conversations support Proteus clients as well as MLS clients. All team conversations and their currently supported protocols can be found in `conv-group-team-protocol.csv`. + +An example counting protocols per team and in total is implemented in the function `team_conversations()` in `analysis/mlsstats.py`. + +### Use-case: Proteus vs MLS client ratio + +In MLS, each conversation is additionally represented by a _group_. +- The mapping from group to conversation can be derived from `conv-group-team-protocol.csv`. +- The MLS clients for each user in each conversation (via the group-to-conversation mapping) can be counted in `domain-user-client-group.csv`. The domain in this table can be ignored. +- The total number of clients for each user can be counted in `user-client.csv`. The number of Proteus clients per user is the difference between total number of clients and MLS clients for this user. +- With the Proteus and MLS clients for each user sorted out, `user-conv.csv` can be used to derive the Proteus and MLS clients for each conversation by summing up the clients for each user in the conversation. + +This is implemented in the function `conversation_clients()` in `analysis/mlsstats.py`. + +## How to locally run MLSStats + +MLSStats accepts a number of arguments for configuring the connection to Cassandra and S3. With the local environment set up, the only argument required is `--s3-bucket-name`. + +## How to run MLSStats in the cluster + +MLSStats displays all its command line arguments when called with the `--help` flag. Close to all arguments have to be provided in order to make the tool correctly conntect to the database and S3. diff --git a/tools/mlsstats/analysis/mlsstats.py b/tools/mlsstats/analysis/mlsstats.py new file mode 100755 index 0000000000..900b85d8ff --- /dev/null +++ b/tools/mlsstats/analysis/mlsstats.py @@ -0,0 +1,106 @@ +#!/usr/bin/env python3 + +import csv + +def team_conversations(): + total = {'proteus': 0, 'mixed': 0, 'mls': 0} + teams = {} + with open('conv-group-team-protocol.csv') as csv_file: + csv_reader = csv.DictReader(csv_file, delimiter=',') + + for row in csv_reader: + team = row['team'] + protocol = row['protocol'] + + if protocol not in ['proteus', 'mixed', 'mls']: + protocol = 'proteus' + if protocol not in total: + total[protocol] = 0 + if team not in teams: + teams[team] = {'proteus': 0, 'mixed': 0, 'mls': 0} + + total[protocol] += 1 + teams[team][protocol] += 1 + + for name, team in teams.items(): + proteus = team['proteus'] + mixed = team['mixed'] + mls = team['mls'] + print(f'In team {name}, conversations ' + + f'in Proteus are {proteus}, ' + + f'in Mixed are {mixed}, and ' + + f'in MLS are {mls}.') + + proteus = total['proteus'] + mixed = total['mixed'] + mls = total['mls'] + print(f'In total, conversations in Proteus are {proteus}, '+ + f'in Mixed are {mixed}, and in MLS are {mls}.') + +def conversation_clients(): + with open('conv-group-team-protocol.csv') as csv_file: + conv = {} + proto = {} + csv_reader = csv.DictReader(csv_file, delimiter=',') + for row in csv_reader: + conversation = row['conversation'] + if row['group'] != '': + conv[row['group']] = conversation + proto[conversation] = row['protocol'] + + with open('domain-user-client-group.csv') as csv_file: + mls_clients = {} + csv_reader = csv.DictReader(csv_file, delimiter=',') + for row in csv_reader: + group = row['group'] + if group in conv: + conversation = conv[group] + user = row['user'] + if conversation not in mls_clients: + mls_clients[conversation] = {user: 0} + if user not in mls_clients[conversation]: + mls_clients[conversation][user] = 0 + mls_clients[conversation][user] += 1 + + with open('user-client.csv') as csv_file: + user_clients = {} + csv_reader = csv.DictReader(csv_file, delimiter=',') + for row in csv_reader: + user = row['user'] + if user not in user_clients: + user_clients[user] = 0 + user_clients[user] += 1 + + with open('user-conv.csv') as csv_file: + conv_clients = {} + csv_reader = csv.DictReader(csv_file, delimiter=',') + for row in csv_reader: + user = row['user'] + conversation = row['conversation'] + if conversation in proto: # only team conversations + if conversation not in conv_clients: + conv_clients[conversation] = {'proteus': 0, 'mls': 0} + if conversation in mls_clients and user in mls_clients[conversation]: + mls = mls_clients[conversation][user] + else: + mls = 0 + if user in user_clients: + proteus = user_clients[user] - mls + else: + proteus = 0 + conv_clients[conversation]['proteus'] += proteus + conv_clients[conversation]['mls'] += mls + + total_proteus = 0 + total_mls = 0 + for name, conversation in conv_clients.items(): + proteus = conversation['proteus'] + mls = conversation['mls'] + protocol = proto[name] + total_proteus += proteus + total_mls += mls + print(f'In conversation {name} ({protocol}), there are ' + + f'{proteus} Proteus clients and {mls} MLS clients.') + + print(f'In total, there are {total_proteus} Proteus clients ' + + f'and {total_mls} MLS clients.') diff --git a/tools/mlsstats/default.nix b/tools/mlsstats/default.nix new file mode 100644 index 0000000000..7c8c906810 --- /dev/null +++ b/tools/mlsstats/default.nix @@ -0,0 +1,58 @@ +# WARNING: GENERATED FILE, DO NOT EDIT. +# This file is generated by running hack/bin/generate-local-nix-packages.sh and +# must be regenerated whenever local packages are added or removed, or +# dependencies are added or removed. +{ mkDerivation +, aeson +, amazonka +, amazonka-s3 +, base +, base64-bytestring +, bytestring +, cassandra-util +, conduit +, filepath +, gitignoreSource +, http-types +, imports +, lens +, lib +, optparse-applicative +, schema-profunctor +, text +, time +, tinylog +, types-common +, wire-api +}: +mkDerivation { + pname = "mlsstats"; + version = "0.1.0"; + src = gitignoreSource ./.; + isLibrary = true; + isExecutable = true; + libraryHaskellDepends = [ + aeson + amazonka + amazonka-s3 + base + base64-bytestring + bytestring + cassandra-util + conduit + filepath + http-types + imports + lens + optparse-applicative + schema-profunctor + text + time + tinylog + types-common + wire-api + ]; + executableHaskellDepends = [ base imports optparse-applicative ]; + license = lib.licenses.agpl3Only; + mainProgram = "mlsstats"; +} diff --git a/tools/mlsstats/exec/Main.hs b/tools/mlsstats/exec/Main.hs new file mode 100644 index 0000000000..4d495c3206 --- /dev/null +++ b/tools/mlsstats/exec/Main.hs @@ -0,0 +1,36 @@ +-- This file is part of the Wire Server implementation. +-- +-- Copyright (C) 2022 Wire Swiss GmbH +-- +-- 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 . + +module Main + ( main, + ) +where + +import Imports +import MlsStats.Options +import MlsStats.Run (run) +import Options.Applicative + +main :: IO () +main = do + opts <- execParser (info (helper <*> optsParser) desc) + run opts + where + desc = + header "mlsstats" + <> progDesc "MLS Stats - Proteus to MLS migration statistics for admins" + <> fullDesc diff --git a/tools/mlsstats/mlsstats.cabal b/tools/mlsstats/mlsstats.cabal new file mode 100644 index 0000000000..eca13c03d3 --- /dev/null +++ b/tools/mlsstats/mlsstats.cabal @@ -0,0 +1,155 @@ +cabal-version: 1.12 +name: mlsstats +version: 0.1.0 +description: collect and provide MLS migration statistics +category: Network +author: Wire Swiss GmbH +maintainer: Wire Swiss GmbH +copyright: (c) 2023 Wire Swiss GmbH +license: AGPL-3 +license-file: LICENSE +build-type: Simple + +flag static + description: Enable static linking + manual: True + default: False + +library + exposed-modules: + MlsStats.Options + MlsStats.Run + + other-modules: Paths_mlsstats + hs-source-dirs: src + default-extensions: + NoImplicitPrelude + AllowAmbiguousTypes + BangPatterns + ConstraintKinds + DataKinds + DefaultSignatures + DeriveFunctor + DeriveGeneric + DeriveLift + DeriveTraversable + DerivingStrategies + DerivingVia + DuplicateRecordFields + EmptyCase + FlexibleContexts + FlexibleInstances + FunctionalDependencies + GADTs + InstanceSigs + KindSignatures + LambdaCase + MultiParamTypeClasses + MultiWayIf + NamedFieldPuns + OverloadedRecordDot + OverloadedStrings + PackageImports + PatternSynonyms + PolyKinds + QuasiQuotes + RankNTypes + ScopedTypeVariables + StandaloneDeriving + TupleSections + TypeApplications + TypeFamilies + TypeFamilyDependencies + TypeOperators + UndecidableInstances + ViewPatterns + + ghc-options: + -O2 -Wall -Wincomplete-uni-patterns -Wincomplete-record-updates + -Wpartial-fields -fwarn-tabs -optP-Wno-nonportable-include-path + -funbox-strict-fields -Wredundant-constraints -Wunused-packages + + build-depends: + aeson + , amazonka >=1.3.7 + , amazonka-s3 >=1.3.7 + , base >=4.6 && <5 + , base64-bytestring + , bytestring + , cassandra-util + , conduit + , filepath + , http-types + , imports + , lens >=4.11 + , optparse-applicative + , schema-profunctor + , text + , time + , tinylog + , types-common >=0.8 + , wire-api + + default-language: GHC2021 + +executable mlsstats + main-is: exec/Main.hs + other-modules: Paths_mlsstats + default-extensions: + NoImplicitPrelude + AllowAmbiguousTypes + BangPatterns + ConstraintKinds + DataKinds + DefaultSignatures + DeriveFunctor + DeriveGeneric + DeriveLift + DeriveTraversable + DerivingStrategies + DerivingVia + DuplicateRecordFields + EmptyCase + FlexibleContexts + FlexibleInstances + FunctionalDependencies + GADTs + InstanceSigs + KindSignatures + LambdaCase + MultiParamTypeClasses + MultiWayIf + NamedFieldPuns + OverloadedRecordDot + OverloadedStrings + PackageImports + PatternSynonyms + PolyKinds + QuasiQuotes + RankNTypes + ScopedTypeVariables + StandaloneDeriving + TupleSections + TypeApplications + TypeFamilies + TypeFamilyDependencies + TypeOperators + UndecidableInstances + ViewPatterns + + ghc-options: + -O2 -Wall -Wincomplete-uni-patterns -Wincomplete-record-updates + -Wpartial-fields -fwarn-tabs -optP-Wno-nonportable-include-path + -threaded -rtsopts -with-rtsopts=-T -Wredundant-constraints + -Wunused-packages + + build-depends: + base + , imports + , mlsstats + , optparse-applicative + + if flag(static) + ld-options: -static + + default-language: GHC2021 diff --git a/tools/mlsstats/src/MlsStats/Options.hs b/tools/mlsstats/src/MlsStats/Options.hs new file mode 100644 index 0000000000..251d9117eb --- /dev/null +++ b/tools/mlsstats/src/MlsStats/Options.hs @@ -0,0 +1,171 @@ +-- This file is part of the Wire Server implementation. +-- +-- Copyright (C) 2022 Wire Swiss GmbH +-- +-- 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 . + +module MlsStats.Options + ( Opts (..), + CassandraSettings (..), + S3Settings (..), + optsParser, + ) +where + +import Amazonka +import Cassandra qualified as C +import Data.Text qualified as Text +import Imports +import Options.Applicative +import Options.Applicative.Types (readerAsk) +import Util.Options + +data Opts = Opts + { cassandraSettings :: CassandraSettings, + s3Settings :: S3Settings + } + deriving (Show, Generic) + +data CassandraSettings = CassandraSettings + { brigHost :: String, + brigPort :: Word16, + brigKeyspace :: C.Keyspace, + galleyHost :: String, + galleyPort :: Word16, + galleyKeyspace :: C.Keyspace, + pageSize :: Int32 + } + deriving (Show) + +data S3Settings = S3Settings + { endpoint :: AWSEndpoint, + region :: Maybe Text, + addressingStyle :: S3AddressingStyle, + bucketName :: Text, + bucketDir :: Maybe String + } + deriving (Show) + +optsParser :: Parser Opts +optsParser = + Opts + <$> cassandraSettingsParser + <*> s3SettingsParser + +cassandraSettingsParser :: Parser CassandraSettings +cassandraSettingsParser = + CassandraSettings + <$> strOption + ( long "brig-cassandra-host" + <> metavar "HOST" + <> help "Cassandra host for Brig" + <> value "localhost" + <> showDefault + ) + <*> option + auto + ( long "brig-cassandra-port" + <> metavar "PORT" + <> help "Cassandra port for Brig" + <> value 9042 + <> showDefault + ) + <*> ( C.Keyspace . Text.pack + <$> strOption + ( long "brig-cassandra-keyspace" + <> metavar "STRING" + <> help "Cassandra Keyspaces for Brig" + <> value ("brig_test") + <> showDefault + ) + ) + <*> strOption + ( long "galley-cassandra-host" + <> metavar "HOST" + <> help "Cassandra host for Galley" + <> value "localhost" + <> showDefault + ) + <*> option + auto + ( long "galley-cassandra-port" + <> metavar "PORT" + <> help "Cassandra port for Brig" + <> value 9042 + <> showDefault + ) + <*> ( C.Keyspace . Text.pack + <$> strOption + ( long "galley-cassandra-keyspace" + <> metavar "STRING" + <> help "Cassandra Keyspaces for Galley" + <> value ("galley_test") + <> showDefault + ) + ) + <*> option + auto + ( long "cassandra-pagesize" + <> metavar "PAGESIZE" + <> help "Cassandra pagesize for queries" + <> value 1024 + <> showDefault + ) + +s3SettingsParser :: Parser S3Settings +s3SettingsParser = + S3Settings + <$> option + parseAWSEndpoint + ( long "s3-endpoint" + <> metavar "URL" + <> help "S3 endpoint" + <> value (AWSEndpoint "localhost" False 4570) + <> showDefault + ) + <*> optional + ( strOption + ( long "s3-region" + <> metavar "S3REGION" + <> help "S3 region" + ) + ) + <*> option + addressingStyleParser + ( long "s3-addressing-style" + <> metavar "ADDRESSINGSTYLE" + <> help "S3 addressing style (path for minio)" + <> value S3AddressingStylePath + <> showDefault + ) + <*> strOption + ( long "s3-bucket-name" + <> metavar "BUCKET" + <> help "S3 bucket" + ) + <*> optional + ( strOption + ( long "s3-bucket-dir" + <> metavar "DIRECTORY" + <> help "S3 bucket directory" + ) + ) + +addressingStyleParser :: ReadM S3AddressingStyle +addressingStyleParser = do + readerAsk >>= \case + "path" -> pure S3AddressingStylePath + "auto" -> pure S3AddressingStyleAuto + "virtual" -> pure S3AddressingStyleVirtual + _ -> readerError "unknown S3 addressing style" diff --git a/tools/mlsstats/src/MlsStats/Run.hs b/tools/mlsstats/src/MlsStats/Run.hs new file mode 100644 index 0000000000..7132d0b8a9 --- /dev/null +++ b/tools/mlsstats/src/MlsStats/Run.hs @@ -0,0 +1,257 @@ +{-# LANGUAGE TupleSections #-} +{-# OPTIONS_GHC -Wno-ambiguous-fields #-} +{-# OPTIONS_GHC -Wno-orphans #-} + +-- This file is part of the Wire Server implementation. +-- +-- Copyright (C) 2022 Wire Swiss GmbH +-- +-- 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 . + +module MlsStats.Run + ( run, + ) +where + +import Amazonka hiding (await) +import Amazonka.S3 +import Amazonka.S3.CreateMultipartUpload +import Amazonka.S3.Lens +import Cassandra as C +import Cassandra.Settings as C +import Conduit +import Control.Exception +import Control.Lens ((.~), (?~), (^.)) +import Data.Aeson qualified as A +import Data.ByteString.Base64 qualified as BS64 +import Data.ByteString.Lazy qualified as LBS +import Data.Conduit.Combinators hiding (foldMap, stderr, stdout) +import Data.Domain +import Data.Id +import Data.List.NonEmpty (nonEmpty) +import Data.Schema +import Data.Text qualified as T +import Data.Text.Encoding qualified as T +import Data.Time +import Data.Time.Format.ISO8601 +import Imports hiding (concat, filter, print) +import MlsStats.Options +import Network.HTTP.Types +import System.FilePath.Posix +import System.Logger qualified as Log +import Util.Options +import Wire.API.Conversation.Protocol +import Wire.API.MLS.Group + +run :: Opts -> IO () +run o = do + logger' <- initLogger + let settings = o.cassandraSettings + galleyTables <- initCas settings.galleyHost settings.galleyPort settings.galleyKeyspace logger' + brigTables <- initCas settings.brigHost settings.brigPort settings.brigKeyspace logger' + runCommand o.s3Settings galleyTables brigTables o.cassandraSettings.pageSize + where + initLogger = + Log.new + . Log.setOutput Log.StdOut + . Log.setFormat Nothing + . Log.setBufSize 0 + $ Log.defSettings + initCas casHost casPort casKeyspace l = + C.init + . C.setLogger (C.mkLogger l) + . C.setContacts casHost [] + . C.setPortNumber (fromIntegral casPort) + . C.setProtocolVersion C.V4 + . C.setKeyspace casKeyspace + $ C.defSettings + +runCommand :: S3Settings -> ClientState -> ClientState -> Int32 -> IO () +runCommand s3 galleyTables brigTables queryPageSize = do + logger <- newLogger Debug stderr + let service = + setEndpoint (s3.endpoint ^. awsSecure) (s3.endpoint ^. awsHost) (s3.endpoint ^. awsPort) defaultService + & service_s3AddressingStyle .~ s3.addressingStyle + env <- + maybe id (\reg e -> (e :: Env) {region = Region' reg}) s3.region + . (\e -> e {logger = logger}) + . configureService service + <$> newEnv discover + now <- formatShowM iso8601Format <$> getCurrentTime + let upload = + uploadStream env (BucketName s3.bucketName) + . ObjectKey + . T.pack + . maybe id () s3.bucketDir + . maybe id () now + runResourceT $ do + upload "user-client.csv" (userClient brigTables queryPageSize) + upload "conv-group-team-protocol.csv" (convGroupTeamProtocol galleyTables queryPageSize) + upload "domain-user-client-group.csv" (domainUserClientGroup galleyTables queryPageSize) + upload "user-conv.csv" (userConv galleyTables queryPageSize) + +userClient :: MonadIO m => ClientState -> Int32 -> ConduitT () ByteString m () +userClient cassandra queryPageSize = do + yield "user,client\r\n" + ( transPipe + (runClient cassandra) + (paginateC userClientCql (paramsP LocalQuorum () queryPageSize) x1) + .| concat + .| mapC (\(u, c) -> T.encodeUtf8 $ T.pack (show u) <> "," <> c.client <> "\r\n") + ) + where + userClientCql :: PrepQuery R () (UserId, ClientId) + userClientCql = "SELECT user, client FROM clients" + +convGroupTeamProtocol :: MonadIO m => ClientState -> Int32 -> ConduitT () ByteString m () +convGroupTeamProtocol cassandra queryPageSize = do + yield "conversation,group,team,protocol\r\n" + ( transPipe + (runClient cassandra) + (paginateC convGroupTeamProtocolCql (paramsP LocalQuorum () queryPageSize) x1) + .| concat + .| mapC (\(c, g, mt, p) -> fmap (c,g,,p) mt) -- filter out non-team conversations + .| concat + .| mapC + ( \(c, g, t, p) -> + T.encodeUtf8 (T.pack (show c)) + <> "," + <> foldMap (BS64.encode . unGroupId) g + <> "," + <> T.encodeUtf8 (T.pack (show t)) + <> "," + <> T.encodeUtf8 (convertProtocol p) + <> "\r\n" + ) + ) + where + convGroupTeamProtocolCql :: PrepQuery R () (ConvId, Maybe GroupId, Maybe TeamId, Maybe ProtocolTag) + convGroupTeamProtocolCql = "SELECT conv, group_id, team, protocol FROM conversation" + convertProtocol :: Maybe ProtocolTag -> Text + convertProtocol p = case schemaToJSON (fromMaybe ProtocolProteusTag p) of + A.String s -> s + _ -> "?" + +domainUserClientGroup :: MonadIO m => ClientState -> Int32 -> ConduitT () ByteString m () +domainUserClientGroup cassandra queryPageSize = do + yield "user_domain,user,client,group\r\n" + ( transPipe + (runClient cassandra) + (paginateC domainUserClientGroupCql (paramsP LocalQuorum () queryPageSize) x1) + .| concat + .| mapC + ( \(d, u, c, g) -> + (T.encodeUtf8 (domainText d)) + <> "," + <> T.encodeUtf8 (T.pack (show u)) + <> "," + <> T.encodeUtf8 (client c) + <> "," + <> BS64.encode (unGroupId g) + <> "\r\n" + ) + ) + where + domainUserClientGroupCql :: PrepQuery R () (Domain, UserId, ClientId, GroupId) + domainUserClientGroupCql = "SELECT user_domain, user, client, group_id FROM mls_group_member_client" + +userConv :: MonadIO m => ClientState -> Int32 -> ConduitT () ByteString m () +userConv cassandra queryPageSize = do + yield "user,conversation\r\n" + ( transPipe + (runClient cassandra) + (paginateC userConvCql (paramsP LocalQuorum () queryPageSize) x1) + .| concat + .| mapC (\(u, c) -> T.encodeUtf8 $ T.pack (show u) <> "," <> T.pack (show c) <> "\r\n") + ) + where + userConvCql :: PrepQuery R () (UserId, ConvId) + userConvCql = "SELECT user, conv FROM user" + +uploadStream :: + Env -> + BucketName -> + ObjectKey -> + ConduitT () ByteString (ResourceT IO) () -> + (ResourceT IO) () +uploadStream env bucket key stream = do + createMultipartResp <- + sendEither env (newCreateMultipartUpload bucket key) >>= \case + Left (ServiceError e) | e.status.statusCode == 404 && e.code == ErrorCode "NoSuchBucket" -> do + void $ send env (newCreateBucket bucket) + send env (newCreateMultipartUpload bucket key) + Left e -> liftIO $ throwIO e + Right resp -> pure resp + let uploadId' = createMultipartResp ^. createMultipartUploadResponse_uploadId + parts <- + runConduit $ + stream + .| chunksOfE chunkSize + .| uploadParts env bucket key uploadId' 0 + .| mapC (uncurry newCompletedPart) + .| sinkList + void $ + send env $ + newCompleteMultipartUpload bucket key uploadId' + & completeMultipartUpload_multipartUpload + ?~ ( newCompletedMultipartUpload + & completedMultipartUpload_parts .~ nonEmpty parts + ) + where + chunkSize = 5 * 1024 * 1024 + +uploadParts :: + Env -> + BucketName -> + ObjectKey -> + Text -> + Int -> + ConduitT ByteString (Int, ETag) (ResourceT IO) () +uploadParts env bucket key uploadId partNum = do + chunkM <- await + case chunkM of + Just chunk -> do + let req = newUploadPart bucket key partNum uploadId $ toBody chunk + resp <- send env req + for_ (resp ^. uploadPartResponse_eTag) $ \etag -> + yield (partNum, etag) + uploadParts env bucket key uploadId (partNum + 1) + Nothing -> pure () + +instance Cql ProtocolTag where + ctype = Tagged IntColumn + + toCql = CqlInt . fromIntegral . fromEnum + + fromCql (CqlInt i) = do + let i' = fromIntegral i + if i' < fromEnum @ProtocolTag minBound + || i' > fromEnum @ProtocolTag maxBound + then Left $ "unexpected protocol: " ++ show i + else Right $ toEnum i' + fromCql _ = Left "protocol: int expected" + +instance Cql GroupId where + ctype = Tagged BlobColumn + + toCql = CqlBlob . LBS.fromStrict . unGroupId + + fromCql (CqlBlob b) = Right . GroupId . LBS.toStrict $ b + fromCql _ = Left "group_id: blob expected" + +instance Cql Domain where + ctype = Tagged TextColumn + toCql = CqlText . domainText + fromCql (CqlText txt) = mkDomain txt + fromCql _ = Left "Domain: Text expected"