Skip to content
Permalink
Browse files

Internal change

PiperOrigin-RevId: 263401013
Change-Id: Iddbec871c0035a1d6940e0d5df671b20915d84fb
  • Loading branch information...
Mako Team authored and timford committed Aug 14, 2019
0 parents commit e3e09a109b5bcc015d3b8be8c879631b324248c0
Showing with 51,046 additions and 0 deletions.
  1. +6 −0 .bazelrc
  2. +14 −0 BUILD
  3. +27 −0 CONTRIBUTING.md
  4. +204 −0 LICENSE
  5. +53 −0 README.md
  6. +10 −0 SUPPORT.md
  7. +228 −0 WORKSPACE
  8. +43 −0 clients/cxx/aggregator/BUILD
  9. +314 −0 clients/cxx/aggregator/standard_aggregator.cc
  10. +191 −0 clients/cxx/aggregator/standard_aggregator.h
  11. +472 −0 clients/cxx/aggregator/standard_aggregator_test.cc
  12. +85 −0 clients/cxx/aggregator/threadsafe_running_stats.h
  13. +123 −0 clients/cxx/analyzers/BUILD
  14. +169 −0 clients/cxx/analyzers/threshold_analyzer.cc
  15. +63 −0 clients/cxx/analyzers/threshold_analyzer.h
  16. +659 −0 clients/cxx/analyzers/threshold_analyzer_test.cc
  17. +866 −0 clients/cxx/analyzers/utest_analyzer.cc
  18. +86 −0 clients/cxx/analyzers/utest_analyzer.h
  19. +1,580 −0 clients/cxx/analyzers/utest_analyzer_test.cc
  20. +85 −0 clients/cxx/analyzers/util.cc
  21. +36 −0 clients/cxx/analyzers/util.h
  22. +125 −0 clients/cxx/analyzers/util_test.cc
  23. +507 −0 clients/cxx/analyzers/window_deviation.cc
  24. +73 −0 clients/cxx/analyzers/window_deviation.h
  25. +2,520 −0 clients/cxx/analyzers/window_deviation_test.cc
  26. +30 −0 clients/cxx/dashboard/BUILD
  27. +296 −0 clients/cxx/dashboard/standard_dashboard.cc
  28. +62 −0 clients/cxx/dashboard/standard_dashboard.h
  29. +287 −0 clients/cxx/dashboard/standard_dashboard_test.cc
  30. +66 −0 clients/cxx/downsampler/BUILD
  31. +72 −0 clients/cxx/downsampler/metric_set.h
  32. +82 −0 clients/cxx/downsampler/metric_set_test.cc
  33. +676 −0 clients/cxx/downsampler/standard_downsampler.cc
  34. +205 −0 clients/cxx/downsampler/standard_downsampler.h
  35. +1,218 −0 clients/cxx/downsampler/standard_downsampler_test.cc
  36. +30 −0 clients/cxx/fileio/BUILD
  37. +215 −0 clients/cxx/fileio/memory_fileio.cc
  38. +147 −0 clients/cxx/fileio/memory_fileio.h
  39. +371 −0 clients/cxx/fileio/memory_fileio_test.cc
  40. +111 −0 clients/cxx/storage/BUILD
  41. +28 −0 clients/cxx/storage/base_storage_client.h
  42. +572 −0 clients/cxx/storage/fake_google3_storage.cc
  43. +342 −0 clients/cxx/storage/fake_google3_storage.h
  44. +1,020 −0 clients/cxx/storage/fake_google3_storage_test.cc
  45. +66 −0 clients/cxx/storage/go/BUILD
  46. +130 −0 clients/cxx/storage/go/fake_storage.swig
  47. +122 −0 clients/cxx/storage/go/google3_storage.swig
  48. +39 −0 clients/cxx/storage/go/mako_client.swig
  49. +416 −0 clients/cxx/storage/google3_storage.cc
  50. +307 −0 clients/cxx/storage/google3_storage.h
  51. +83 −0 clients/cxx/storage/mako_client.cc
  52. +57 −0 clients/cxx/storage/mako_client.h
  53. +45 −0 clients/cxx/storage/mako_client_internal.h
  54. +57 −0 clients/cxx/storage/mako_client_test.cc
  55. +50 −0 clients/go/storage/BUILD
  56. +141 −0 clients/go/storage/fake_storage.go
  57. +485 −0 clients/go/storage/fake_storage_test.go
  58. +32 −0 clients/go/storage/google3_storage.go
  59. +65 −0 clients/go/storage/mako.go
  60. +61 −0 clients/proto/analyzers/BUILD
  61. +223 −0 clients/proto/analyzers/threshold_analyzer.proto
  62. +432 −0 clients/proto/analyzers/threshold_analyzer_go_proto/threshold_analyzer.pb.go
  63. +261 −0 clients/proto/analyzers/utest_analyzer.proto
  64. +495 −0 clients/proto/analyzers/utest_analyzer_go_proto/utest_analyzer.pb.go
  65. +244 −0 clients/proto/analyzers/window_deviation.proto
  66. +855 −0 clients/proto/analyzers/window_deviation_go_proto/window_deviation.pb.go
  67. +6 −0 common.bzl
  68. +633 −0 curl.BUILD
  69. +43 −0 docs/ACCESS.md
  70. +164 −0 docs/ANALYZERS.md
  71. +43 −0 docs/AUTHENTICATION.md
  72. +149 −0 docs/BUILDING.md
  73. +101 −0 docs/CLI.md
  74. +136 −0 docs/CONCEPTS.md
  75. +360 −0 docs/GUIDE.md
  76. +90 −0 docs/STORAGE_LIBRARY.md
  77. +102 −0 docs/TAGS.md
  78. +46 −0 docs/THRESHOLD_ANALYZER.md
  79. +231 −0 docs/UTEST_ANALYZER.md
  80. +539 −0 docs/WDA_ANALYZER.md
  81. BIN docs/images/analyzer_failure_from_aggregate_chart.png
  82. BIN docs/images/analyzer_failure_from_run_chart.png
  83. BIN docs/images/benchmark_example.png
  84. BIN docs/images/mako_triage_banner.png
  85. BIN docs/images/mako_vertical_round_hdpi.png
  86. BIN docs/images/run_example.png
  87. +10 −0 examples/benchmark_info/BUILD
  88. +43 −0 examples/benchmark_info/create_benchmark.config
  89. +44 −0 examples/benchmark_info/update_benchmark.config
  90. +3 −0 go.mod
  91. +60 −0 helpers/cxx/quickstore/BUILD
  92. +66 −0 helpers/cxx/quickstore/internal/BUILD
  93. +580 −0 helpers/cxx/quickstore/internal/store.cc
  94. +123 −0 helpers/cxx/quickstore/internal/store.h
  95. +703 −0 helpers/cxx/quickstore/internal/store_test.cc
  96. +148 −0 helpers/cxx/quickstore/quickstore.cc
  97. +181 −0 helpers/cxx/quickstore/quickstore.h
  98. +239 −0 helpers/cxx/quickstore/quickstore_example_test.cc
  99. +52 −0 helpers/cxx/status/BUILD
  100. +144 −0 helpers/cxx/status/canonical_errors.cc
  101. +71 −0 helpers/cxx/status/canonical_errors.h
  102. +37 −0 helpers/cxx/status/status.cc
  103. +36 −0 helpers/cxx/status/status.h
  104. +60 −0 helpers/cxx/status/status_matchers.cc
  105. +417 −0 helpers/cxx/status/status_matchers.h
  106. +51 −0 helpers/cxx/status/status_matchers_test.cc
  107. +29 −0 helpers/cxx/status/statusor.h
  108. +23 −0 helpers/go/quickstore/BUILD
  109. +301 −0 helpers/go/quickstore/quickstore.go
  110. +441 −0 helpers/proto/quickstore/quickstore_go_proto/quickstore.pb.go
  111. +248 −0 internal/cxx/BUILD
  112. +85 −0 internal/cxx/analyzer_common.cc
  113. +43 −0 internal/cxx/analyzer_common.h
  114. +283 −0 internal/cxx/analyzer_optimizer.cc
  115. +133 −0 internal/cxx/analyzer_optimizer.h
  116. +1,258 −0 internal/cxx/analyzer_optimizer_test.cc
  117. +35 −0 internal/cxx/backoff.cc
  118. +36 −0 internal/cxx/backoff.h
  119. +64 −0 internal/cxx/backoff_test.cc
  120. +28 −0 internal/cxx/clock.h
  121. +48 −0 internal/cxx/clock_external.cc
  122. +35 −0 internal/cxx/clock_external.h
  123. +56 −0 internal/cxx/clock_mock.h
  124. +332 −0 internal/cxx/filter_utils.cc
  125. +74 −0 internal/cxx/filter_utils.h
  126. +884 −0 internal/cxx/filter_utils_test.cc
  127. +105 −0 internal/cxx/load/common/BUILD
  128. +120 −0 internal/cxx/load/common/executor.h
  129. +138 −0 internal/cxx/load/common/executor_test.cc
  130. +249 −0 internal/cxx/load/common/run_analyzers.cc
  131. +48 −0 internal/cxx/load/common/run_analyzers.h
  132. +422 −0 internal/cxx/load/common/run_analyzers_test.cc
  133. +94 −0 internal/cxx/load/common/thread_pool.h
  134. +27 −0 internal/cxx/load/common/thread_pool_factory.cc
  135. +29 −0 internal/cxx/load/common/thread_pool_factory.h
  136. +55 −0 internal/cxx/load/common/thread_pool_test.cc
  137. +243 −0 internal/cxx/pgmath.cc
  138. +159 −0 internal/cxx/pgmath.h
  139. +395 −0 internal/cxx/pgmath_test.cc
  140. +329 −0 internal/cxx/proto_cache.h
  141. +627 −0 internal/cxx/proto_cache_test.cc
  142. +193 −0 internal/cxx/proto_validation.cc
  143. +75 −0 internal/cxx/proto_validation.h
  144. +178 −0 internal/cxx/proto_validation_test.cc
  145. +118 −0 internal/cxx/queue.h
  146. +68 −0 internal/cxx/queue_ifc.h
  147. +180 −0 internal/cxx/queue_test.cc
  148. +169 −0 internal/cxx/storage_client/BUILD
  149. +121 −0 internal/cxx/storage_client/google_oauth_fetcher.cc
  150. +52 −0 internal/cxx/storage_client/google_oauth_fetcher.h
  151. +89 −0 internal/cxx/storage_client/google_oauth_fetcher_test.cc
  152. +336 −0 internal/cxx/storage_client/http_client.cc
  153. +108 −0 internal/cxx/storage_client/http_client.h
  154. +173 −0 internal/cxx/storage_client/http_transport.cc
  155. +105 −0 internal/cxx/storage_client/http_transport.h
  156. +42 −0 internal/cxx/storage_client/mock_transport.h
  157. +33 −0 internal/cxx/storage_client/oauth_token_provider.h
  158. +95 −0 internal/cxx/storage_client/retry_strategy.h
  159. +98 −0 internal/cxx/storage_client/retry_strategy_test.cc
  160. +117 −0 internal/cxx/storage_client/retrying_storage_request.h
  161. +69 −0 internal/cxx/storage_client/transport.h
  162. +190 −0 internal/cxx/storage_client/url.cc
  163. +68 −0 internal/cxx/storage_client/url.h
  164. +286 −0 internal/cxx/storage_client/url_test.cc
  165. +49 −0 internal/cxx/utils/BUILD
  166. +122 −0 internal/cxx/utils/cleanup.h
  167. +267 −0 internal/cxx/utils/cleanup_test.cc
  168. +37 −0 internal/cxx/utils/googleinit.h
  169. +48 −0 internal/cxx/utils/stringutil.cc
  170. +28 −0 internal/cxx/utils/stringutil.h
  171. +119 −0 internal/cxx/utils/stringutil_test.cc
  172. +15 −0 internal/go/BUILD
  173. +14 −0 internal/go/common/BUILD
  174. +17 −0 internal/go/common/common_deps.go
  175. +321 −0 internal/go/wrappedstorage.go
  176. +17 −0 internal/grpc/BUILD
  177. +14 −0 internal/proto/BUILD
  178. +102 −0 internal/proto/mako_internal.proto
  179. +80 −0 internal/quickstore_microservice/BUILD
  180. +68 −0 internal/quickstore_microservice/main.cc
  181. +50 −0 internal/quickstore_microservice/proto/BUILD
  182. +76 −0 internal/quickstore_microservice/proto/quickstore.proto
  183. +360 −0 internal/quickstore_microservice/proto/quickstore_go_grpc_pb/quickstore.pb.go
  184. +360 −0 internal/quickstore_microservice/proto/quickstore_go_proto/quickstore.pb.go
  185. +65 −0 internal/quickstore_microservice/quickstore_service.cc
  186. +59 −0 internal/quickstore_microservice/quickstore_service.h
  187. +221 −0 internal/quickstore_microservice/quickstore_service_test.cc
  188. +47 −0 internal/tools/cli/BUILD
  189. +1,590 −0 internal/tools/cli/lib.go
  190. +692 −0 internal/tools/cli/lib_test.go
  191. +53 −0 internal/tools/cli/mako.go
  192. +35 −0 mako_examples/cxx_quickstore/BUILD
  193. +4 −0 mako_examples/cxx_quickstore/README.md
  194. +148 −0 mako_examples/cxx_quickstore/example_test.cc
  195. +42 −0 mako_examples/cxx_quickstore/perf_data.proto
  196. +5 −0 mako_examples/go_quickstore/README.md
  197. +224 −0 mako_examples/go_quickstore/example_test.go
  198. +9 −0 mako_examples/go_quickstore/go.mod
  199. +28 −0 mako_examples/go_quickstore/go.sum
  200. +51 −0 mako_examples/go_quickstore/performance_test_data.json
  201. +80 −0 pcre.BUILD
  202. +34 −0 quickstore/BUILD
  203. +134 −0 quickstore/quickstore.proto
  204. +81 −0 spec/cxx/BUILD
  205. +50 −0 spec/cxx/aggregator.h
  206. +54 −0 spec/cxx/analyzer.cc
  207. +102 −0 spec/cxx/analyzer.h
  208. +50 −0 spec/cxx/analyzer_factory.h
  209. +46 −0 spec/cxx/dashboard.cc
  210. +82 −0 spec/cxx/dashboard.h
  211. +53 −0 spec/cxx/downsampler.h
  212. +140 −0 spec/cxx/fileio.h
  213. +39 −0 spec/cxx/mock_analyzer.h
  214. +63 −0 spec/cxx/mock_storage.h
  215. +274 −0 spec/cxx/storage.h
  216. +18 −0 spec/go/BUILD
  217. +248 −0 spec/go/storage.go
  218. +23 −0 spec/proto/BUILD
  219. +2,053 −0 spec/proto/mako.proto
  220. +4,052 −0 spec/proto/mako_go_proto/mako.pb.go
  221. +350 −0 swig.BUILD
  222. +8 −0 swig/BUILD
  223. +112 −0 swig/base.swig
  224. +8 −0 swig/go/BUILD
  225. +496 −0 swig/go/protofunc.swig
  226. +95 −0 swig/go/strings.swig
  227. +150 −0 swig/swig.bzl
  228. +21 −0 testing/cxx/BUILD
  229. +389 −0 testing/cxx/protocol-buffer-matchers.cc
  230. +1,119 −0 testing/cxx/protocol-buffer-matchers.h
@@ -0,0 +1,6 @@
# Necessary for building
# //internal/quickstore_microservice:quickstore_microservice_mako_image. See
# https://github.com/bazelbuild/rules_docker/issues/842.
build --host_force_python=PY2
test --host_force_python=PY2
run --host_force_python=PY2
14 BUILD
@@ -0,0 +1,14 @@
# Mako is a complete performance verification framework that offers data
# storage, charting, statistical aggregation, automated regression analysis,
# and local or distributed load generation and sampling.

licenses(["notice"]) # Apache 2.0

exports_files(["LICENSE"])

package_group(
name = "internal",
packages = [
"//...",
],
)
@@ -0,0 +1,27 @@
# How to Contribute

We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.

## Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License
Agreement. You (or your employer) retain the copyright to your contribution;
this simply gives us permission to use and redistribute your contributions as
part of the project. Head over to <https://cla.developers.google.com/> to see
your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one
(even if it was for a different project), you probably don't need to do it
again.

## Code reviews

We're still working out our workflow for accepting code contributions. Please
start by creating a GitHub issue with details about what you want to do and why,
and we'll talk about how to best go about it.

## Community Guidelines

This project follows [Google's Open Source Community
Guidelines](https://opensource.google.com/conduct/).
204 LICENSE
@@ -0,0 +1,204 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.


@@ -0,0 +1,53 @@
# Mako - A performance testing library and service

![Mako](./docs/images/mako_vertical_round_hdpi.png)

Mako is a set of tools for pre-production performance testing. It offers:

* data storage
* charting
* statistical aggregation
* automated regression analysis
* workflows for triaging potential regressions

Mako is narrowly focused on meeting the performance testing needs of Google open
source projects. At this time, Mako is not intended to be used by projects
outside this limited scope.

# Using Mako

## Performance tests that use Mako
Mako client libraries are designed to be called from a client project’s
performance test code. See the client project’s documentation for how to run
their performance tests.

Since Mako performance tests upload data to https://mako.dev, they require
access rights to run. Please see [ACCESS.md](docs/ACCESS.md).

## Mako Dashboard
Results from performance tests that use Mako are visible to the world. Visit
https://mako.dev to browse the results. Find dashboard documentation at
https://mako.dev/help.

## Mako Command-line Tool
The Mako command-line tool can be used to gain programmatic access to the same
Mako data that’s available on the dashboard. This tool is used by benchmark
owners to manage their benchmarks and runs.

To learn about how to use the Mako command-line tool, please read
[CLI.md](docs/CLI.md).

## Writing a new performance test using Mako
If you’re writing a new performance test that will use a Mako client to store
results in https://mako.dev and to guard against performance regressions, please
read [GUIDE.md](docs/GUIDE.md).

There are example performance tests in the [`mako_examples/`](./mako_examples)
folder.

## Accessing Mako data with the storage libaries
The most common programmatic use of Mako is to create a new run from performance
test data, and for that use case we recommend
[Quickstore](docs/CONCEPTS.md#quickstore). But if you need different kinds of
access to the data (e.g. updating or deleting existing data), you’ll want to use
the C++ or Go [storage library](docs/STORAGE_LIBRARY.md).
@@ -0,0 +1,10 @@
For questions about access to Mako, please see [ACCESS.md](docs/ACCESS.md).

For issues with a particular Mako test, or with a particular Mako benchmark on
https://mako.dev, please reach out to the team owning that benchmark. Contact
information may be in the Benchmark Details section of the benchmark summary
page (with a URL like https://mako.dev/benchmark?benchmark_key=XXXXXXX), or in
the GitHub repo containing the Mako test.

If you have issues or questions about the Mako service or codebase itself,
please add a GitHub issue to https://github.com/google/mako.

0 comments on commit e3e09a1

Please sign in to comment.
You can’t perform that action at this time.