traces 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5607b84ea305909814070a3f676a482f8bcba4e5cdd9c02a596c2ff5b3339581
-  data.tar.gz: 77dd122a80f5076fd4e756fd1c1b552d39e3933590e5d9e4eabc6cfaf99a2029
+  metadata.gz: 47a1acf4edcb177776f172b8743e6beeae7161c6651819eab63a0206d15a7110
+  data.tar.gz: 613f2bc265314167f2673a67a27cae51d5dd471479e9891da2de915611936846
 SHA512:
-  metadata.gz: cd270af76e74ef101e0aa96fd4c12a8447ee816915f0396242908124b4b32257a6c13fc8121c1aa7cd3c8afccdbaf9ce8fb20a5808c2e4180a5899f51f51a9d1
-  data.tar.gz: 7198fdcbfc650f41cc3bdc6487481d9aa1a3e1e180bda5ae851ea116d0eff9bb2c11688b5b72483d88362dfefcb7dcd16be9777d80b58ac7386bf585bbddd488
+  metadata.gz: f74c9b5e55f2b231db24aaea42fb0fb1d5803b0e0da7f5332fc72158a5ddf5b59d1f2be8ad7fbb32f9c86890ffb517aa396eef32312b9758ef5bed35595a3cb4
+  data.tar.gz: e54b6e4ab49a9a1c9fe9426e4d473eefe9ad43f6c53b8a562f0013c280df6ed27f675e2f77dc7693b77d63590809c627eb051f16a0ac8d941102e79c6045c480

data/conduct.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/lib/traces/backend/capture.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require_relative '../context'
+
+require 'fiber'
+
+class Fiber
+	attr_accessor :traces_backend_context
+end
+
+module Traces
+	module Backend
+		# A backend which logs all spans to the Capture logger output.
+		module Capture
+			# A span which validates tag assignment.
+			class Span
+				def initialize(context, instance, name, resource, attributes)
+					@context = context
+					@instance = instance
+					@name = name
+					@resource = resource
+					@attributes = attributes
+				end
+				
+				attr :context
+				attr :instance
+				attr :name
+				attr :resource
+				attr :attributes
+				
+				# Assign some metadata to the span.
+				# @parameter key [String] The metadata key.
+				# @parameter value [Object] The metadata value. Should be coercable to a string.
+				def []= key, value
+					@attributes[key] = value
+				end
+				
+				def as_json
+					{
+						name: @name,
+						resource: @resource,
+						attributes: @attributes,
+						context: @context.as_json
+					}
+				end
+				
+				def to_json(...)
+					as_json.to_json(...)
+				end
+			end
+			
+			def self.spans
+				@spans ||= []
+			end
+			
+			module Interface
+				# Trace the given block of code and log the execution.
+				# @parameter name [String] A useful name/annotation for the recorded span.
+				# @parameter attributes [Hash] Metadata for the recorded span.
+				def trace(name, resource: self, attributes: {}, &block)
+					context = Context.nested(Fiber.current.traces_backend_context)
+					Fiber.current.traces_backend_context = context
+					
+					span = Span.new(context, self, name, resource, attributes)
+					Capture.spans << span
+					
+					yield span
+				end
+				
+				# Assign a trace context to the current execution scope.
+				def trace_context= context
+					Fiber.current.traces_backend_context = context
+				end
+				
+				# Get a trace context from the current execution scope.
+				def trace_context
+					Fiber.current.traces_backend_context
+				end
+			end
+		end
+		
+		Interface = Capture::Interface
+	end
+end

data/lib/traces/backend.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 module Traces
 	# Require a specific trace backend.
 	def self.require_backend(env = ENV)
 		if backend = env['TRACES_BACKEND']
 			require(backend)
+			
+			Traces.extend(Backend::Interface)
 		end
 	end
 end

data/lib/traces/context.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 require 'securerandom'
 
@@ -86,5 +86,19 @@ module Traces
 		def to_s
 			"00-#{@trace_id}-#{@parent_id}-#{@flags.to_s(16)}"
 		end
+		
+		def as_json
+			{
+				trace_id: @trace_id,
+				parent_id: @parent_id,
+				flags: @flags,
+				state: @state,
+				remote: @remote
+			}
+		end
+		
+		def to_json(...)
+			as_json.to_json(...)
+		end
 	end
 end

data/lib/traces/provider.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 require_relative 'backend'
 
@@ -21,6 +21,23 @@ module Traces
 		end
 	end
 	
+	module Deprecated
+		def trace(...)
+			warn "Traces::Provider.trace is deprecated. Please use Traces.trace instead."
+			Traces.trace(...)
+		end
+		
+		def trace_context
+			warn "Traces::Provider.trace_context is deprecated. Please use Traces.trace_context instead."
+			Traces.trace_context
+		end
+		
+		def trace_context=(value)
+			warn "Traces::Provider.trace_context= is deprecated. Please use Traces.trace_context= instead."
+			Traces.trace_context = value
+		end
+	end
+	
 	private_constant :Singleton
 	
 	# Bail out if there is no backend configured.
@@ -30,7 +47,7 @@ module Traces
 			klass.extend(Singleton)
 			
 			provider = klass.traces_provider
-			provider.prepend(Backend::Interface)
+			provider.prepend(Deprecated)
 			
 			klass.prepend(provider)
 			

data/lib/traces/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2023, by Samuel Williams.
 
 module Traces
-	VERSION = "0.8.0"
+	VERSION = "0.10.0"
 end

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2021-2022, by Samuel Williams.  
+Copyright, 2021-2023, by Samuel Williams.  
 Copyright, 2022, by Felix Yan.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/readme.md

@@ -17,11 +17,11 @@ Please see the [project documentation](https://socketry.github.io/traces).
 
 We welcome contributions to this project.
 
-1.  Fork it
-2.  Create your feature branch (`git checkout -b my-new-feature`)
-3.  Commit your changes (`git commit -am 'Add some feature'`)
-4.  Push to the branch (`git push origin my-new-feature`)
-5.  Create new Pull Request
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
 
 ## See Also
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: traces
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -38,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-11-10 00:00:00.000000000 Z
+date: 2023-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake-test
@@ -102,8 +102,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- conduct.md
 - lib/traces.rb
 - lib/traces/backend.rb
+- lib/traces/backend/capture.rb
 - lib/traces/backend/console.rb
 - lib/traces/backend/test.rb
 - lib/traces/context.rb
@@ -130,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Application instrumentation and tracing.