forked from awslabs/swage
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial commit of Swage libraries to public repo.
- Loading branch information
Powers
committed
Aug 18, 2017
0 parents
commit 8fe5d3e
Showing
72 changed files
with
8,863 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
.idea | ||
*.iml | ||
/out | ||
target/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,201 @@ | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
Swage | ||
Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# Swage | ||
|
||
Swage is a collection of libraries useful for developing and running services. | ||
|
||
Currently it consists of the following Java libraries: | ||
* Metrics | ||
* Type Safe | ||
* Thread Context | ||
* Disseminating Executors | ||
|
||
|
||
## Metrics | ||
|
||
The Swage Metrics library provides a clean, robust API for recording metric | ||
events in a Java application, as well as a core implementation for sending the | ||
instrumented metric data to AWS CloudWatch. | ||
|
||
It consists of the following modules: | ||
* metrics-core | ||
* metrics-api | ||
|
||
## Type Safe | ||
|
||
Swage Type Safe is a small library that provides type-safe solutions that are | ||
not part of the Java standard libraries. At the moment it consists soley of | ||
the TypedMap, a class for storing heterogenous key/value pairs in a a type safe | ||
way. | ||
|
||
It lives in the type-safe module. | ||
|
||
|
||
## Thread Context | ||
|
||
Swage Thread Context is a library to help manage and propagate task context in | ||
an application across threads. Where a ThreadLocal can help manage context | ||
within one thread, this library provides a way to manage context where a task | ||
may span many threads. | ||
|
||
It lives in the thread-context module. | ||
|
||
|
||
## Disseminating Executors | ||
|
||
The Disseminating Executors library solves the same basic problem as the Thread | ||
Context library, but with a different approach. Ths library is intended to | ||
allow targetd state to cross thread boundaries without invasive changes at | ||
every execution point. It uses custom task executors to capture and propagate | ||
state. | ||
|
||
It lives in the disseminating-executors module. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,129 @@ | ||
# State Captures | ||
|
||
This library is intended to allow targeted state to cross thread | ||
boundaries without invasive changes at every execution point. In | ||
particular, this enables the developers of framework components the | ||
ability to, with higher confidence than before, transition their | ||
thread-local state through multiple thread pools to some relevant exit | ||
point. | ||
|
||
# Example usage | ||
|
||
```java | ||
ExecutorService e = Executors.newCachedThreadPool(); | ||
e = StateCapture.capturingDecorator(e); | ||
``` | ||
|
||
# Getting started | ||
|
||
For application owners, wrap your `Executors`, `ExecutorService`s | ||
and `CompletionService`s with `StateCapture.capturingDecorator()`. | ||
If passing a lambda to a library that controls its own thread pool, | ||
an application can call `StateCapture.capturingDecorator()` on | ||
the runnable or callable itself. | ||
|
||
# Design goals | ||
## Motivating example: tracing | ||
|
||
A tracing module to a framework could place the data | ||
they would like to transfer from the entry point to a service to | ||
the other web clients, so tracing identifiers can be propagated over | ||
the wire. Tracing is a system-wide cross-cutting concern, but making | ||
every simple application explicitly wire through all tracing state is | ||
tedious. For applications that are entirely single-threaded, this is | ||
simple: just use an ordinary thread local. Unfortunately, this breaks | ||
at the first use of any executors, commonly used for asynchronous IO. | ||
|
||
If the executors are aware of the data that needs to be moved, then | ||
there's no problem - the data can be copied from one thread to the next. | ||
However, modifying all points in execution to make this copying happen | ||
is often a prohibitive amount of work. Making it possible to implement | ||
applications and frameworks in a forward-compatible way for these | ||
scenarios should reduce maintenance costs and long-term burden. | ||
|
||
## Motivating example: Logging | ||
|
||
Logging setups frequently reference thread-local data to put | ||
information in logs. Log4j 2.x, for example, has both a | ||
"thread context stack" and a "thread context map". Log formats | ||
can refer to variables in these thread context variables. | ||
|
||
High quality logs have a huge impact on the operational ability | ||
of teams to identify and fix issues in production, and log metadata | ||
working as expected across thread boundaries helps reduce MTTR. | ||
|
||
Log4j 2.x doesn't provide a convenient mechanism to move data across | ||
threads and, even if it did, it would be logging-framework specific. | ||
There is no general solution that multiple logging frameworks have | ||
adopted. A good solution to this problem should be able to work with | ||
any logging framework, including ones not yet identified, or any | ||
other third-party framework with similar requirements. It should not | ||
require the third-party to make invasive changes to enable this; | ||
ideally it would require no changes at all. | ||
|
||
## Motivating example: non-thread-safe child objects | ||
|
||
Some libraries aren't thread safe, but also have some state that | ||
needs to move from thread to thread. In these cases, a child object | ||
can be created with the required metadata and passed into the next | ||
thread. These objects also sometimes require some kind of cleanup | ||
to occur; this should also be possible. | ||
|
||
# Functionality | ||
This library seeks to address all of the motivating scenarios by | ||
being unopinionated about the needs of different libraries and | ||
making it possible for them to implement however fits their world | ||
view. By providing hooks to provide data to pass across a thread | ||
boundary and to execute code before and after executing the real | ||
business task, libraries can do whatever they need to do. | ||
|
||
## High-level implementation | ||
|
||
At a high level, this library allows state to be captured or created | ||
by a calling thread in a plugin, moved to the scope of a calling thread, | ||
then the plugins are given execution control of the data from within | ||
the called thread. | ||
|
||
1. A method like `submit()` is called on a wrapped executor | ||
2. Every plugin is asked for an object representing captured state | ||
3. The callee thread begins execution | ||
4. A before method is called on the object containing the captured state | ||
5. The actual method is called | ||
6. An after method is called on the object containing the captured state | ||
|
||
## Limitations | ||
|
||
This library is not a silver bullet. For example, if data is | ||
transferred from one thread to another via a shared reference | ||
to a concurrent data structure, there is no opportunity for | ||
captured state to be created or processed. This also cannot transfer | ||
data across other boundaries that do not participate. For example, | ||
a library may have its own thread pool and create its own tasks. This | ||
library does not provide a mechanism to make all thread pools | ||
capture and move state. | ||
|
||
# Application integration | ||
## Single-threaded applications | ||
Applications that use a single thread don't need to do anything | ||
## Applications with thread pools | ||
Applications that use thread pools need to wrap all the thread pools | ||
they wish to capture state with a state capturing decorator. | ||
## Applications that use shared data structures to pass data between threads | ||
These applications will need to integrate with their various | ||
frameworks and tools through some manual manner since there | ||
is no automatable mechanism to transfer state between threads | ||
in this case. | ||
# Tool integration | ||
|
||
Tools that want to capture and move state with this mechanism must | ||
implement two interfaces: `CapturedState` | ||
and `StateCaptor`. Additionally, | ||
the implemented `StateCaptor` should include in the jar via | ||
the [`ServiceLoader`][1]. To use this, put a text file at | ||
`META-INF/services/StateCaptor` | ||
with each fully qualified implementation of `StateCaptor` on | ||
its own line. These will be picked up and used at runtime. This can also | ||
be achieved using [Google's AutoService][2]. | ||
|
||
[1]: http://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html | ||
[2]: https://github.com/google/auto/tree/master/service |
Oops, something went wrong.