Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
T
tracingplane-java
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
cld
tracing
tracingplane-java
Commits
57d830e6
Commit
57d830e6
authored
May 18, 2017
by
Jonathan Mace
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update some docs
parent
b4969fbb
Changes
6
Hide whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
84 additions
and
3 deletions
+84
-3
atomlayer/core/src/main/java/brown/tracingplane/atomlayer/package-info.java
.../main/java/brown/tracingplane/atomlayer/package-info.java
+9
-3
baggagecontext/api/src/main/java/brown/tracingplane/package-info.java
...xt/api/src/main/java/brown/tracingplane/package-info.java
+30
-0
baggageprotocol/core/README.md
baggageprotocol/core/README.md
+5
-0
baggageprotocol/core/src/main/java/brown/tracingplane/baggageprotocol/package-info.java
...java/brown/tracingplane/baggageprotocol/package-info.java
+21
-0
bdl/core/src/main/java/brown/tracingplane/bdl/package-info.java
...re/src/main/java/brown/tracingplane/bdl/package-info.java
+19
-0
bdl/examples/src/test/java/brown/tracingplane/bdl/examples/Example.java
...rc/test/java/brown/tracingplane/bdl/examples/Example.java
+0
-0
No files found.
atomlayer/core/src/main/java/brown/tracingplane/atomlayer/package-info.java
View file @
57d830e6
/**
*
* <p>
*
<code>brown.tracingplane.atomlayer</code> contains some of the core atom-based functions of the Tracing Plane,
*
including implementations of lexicographic comparison and lexicographic merge
.
*
Provides the Tracing Plane's core underlying data representation for {@link BaggageContext} based on <i>atoms</i> and
*
<i>lexicographic merge</i>
.
* </p>
*
* <p>
* In general, this code uses {@link ByteBuffer}s to represent atoms.
* The key primitives provided by the Atom Layer are an intermediary data format for {@link BaggageContext}s based on
* <i>atoms</i>, along with the default atom-based comparison and merge functions based on the lexicographic ordering of
* atoms.
* </p>
*
* <p>
* The Atom Layer represents atoms using {@link ByteBuffer}s.
* </p>
*
* <p>
...
...
baggagecontext/api/src/main/java/brown/tracingplane/package-info.java
0 → 100644
View file @
57d830e6
/**
* <p>
* Provides the main {@link BaggageContext} and {@link BaggageProvider} interfaces of the Tracing Plane
* </p>
*
* <p>
* At a high level, {@link BaggageContext} instances exist at the granularity of requests (or tasks, jobs, etc). The
* purpose is to propagate a {@link BaggageContext} alongside each request while it executes. {@link BaggageContext}s
* carry user-defined or tracing-tool defined data.
* </p>
*
* <p>
* {@link BaggageContext} instances should follow requests in a fine-grained manner. For example, if a request splits
* off into multiple concurrent execution branches, then each branch of execution should receive its its own
* {@link BaggageContext} instance, created by calling {@link BaggageProvider#branch(BaggageContext)} at the time the
* request splits.
* </p>
*
* <p>
* Likewise, if multiple concurrent branches merge, or if some task is dependent upon multiple predecessors completing,
* then {@link BaggageContext} instances can be merged using
* {@link BaggageProvider#join(BaggageContext, BaggageContext)}.
* </p>
*
* <p>
* The Tracing Plane provides several {@link BaggageContext} implementations, the main implementation being
* {@link brown.tracingplane.impl.BDLContext} in the {@link brown.tracingplane.bdl} package.
* </p>
*/
package
brown.tracingplane
;
baggageprotocol/core/README.md
0 → 100644
View file @
57d830e6
# Tracing Plane - Baggage Protocol
The Baggage Protocol defines interfaces for nested data structures, along with an atom-based encoding scheme for the nested data structures.
The encoding scheme is such that the Atom Layer's lexicographic merge behaves consistently with an equivalent object-level merge.
\ No newline at end of file
baggageprotocol/core/src/main/java/brown/tracingplane/baggageprotocol/package-info.java
0 → 100644
View file @
57d830e6
/**
* <p>
* Defines an encoding scheme for nested data structures using atoms.
* </p>
*
* <p>
* The Baggage Protocol reads and writes {@link BaggageContext}s with a pre-order depth-first traversal. Starting from
* the root of the tree, we first have data for that node, followed by child nodes. Child nodes can be addressed by
* either statically defined indices, or by arbitrary-length key.
* </p>
*
* <p>
* The {@link BaggageReader} and {@link BaggageWriter} classes are used for reading and writing atoms for
* {@link BaggageContext} instances.
* </p>
*
* <p>
* Details of the baggage protocol can be found on the project GitHub repository.
* </p>
*/
package
brown.tracingplane.baggageprotocol
;
bdl/core/src/main/java/brown/tracingplane/bdl/package-info.java
0 → 100644
View file @
57d830e6
/**
* <p>
* Library classes used by BDL-generated objects, including the {@link BDLContext} implementation of
* {@link BaggageContext}.
* </p>
*
* <p>
* The two main interfaces used by BDL are {@link Bag} and {@link BaggageHandler}. {@link Bag}s are nodes in the nested
* data structure tree, while {@link BaggageHandler}s provide branch, join, and serialization logic for {@link Bag}s.
* {@link Bag} and {@link BaggageHandler} are conceptually similar to {@link BaggageContext} and {@link BaggageProvider}
* , except applying to nodes within a {@link BDLContext}.
* </p>
*
* <p>
* The BDL library classes also include CRDT-like data structures that the BDL supports, such as counters, implemented
* by {@link CounterImpl}.
* </p>
*/
package
brown.tracingplane.bdl
;
bdl/examples/src/
main
/java/brown/tracingplane/bdl/examples/Example.java
→
bdl/examples/src/
test
/java/brown/tracingplane/bdl/examples/Example.java
View file @
57d830e6
File moved
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment