tasker-engine 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENSE +22 -0
- data/README.md +443 -0
- data/Rakefile +10 -0
- data/app/controllers/tasker/analytics_controller.rb +179 -0
- data/app/controllers/tasker/application_controller.rb +45 -0
- data/app/controllers/tasker/graphql_controller.rb +193 -0
- data/app/controllers/tasker/handlers_controller.rb +217 -0
- data/app/controllers/tasker/health_controller.rb +229 -0
- data/app/controllers/tasker/metrics_controller.rb +111 -0
- data/app/controllers/tasker/page_sort.rb +97 -0
- data/app/controllers/tasker/task_diagrams_controller.rb +30 -0
- data/app/controllers/tasker/tasks_controller.rb +123 -0
- data/app/controllers/tasker/workflow_steps_controller.rb +69 -0
- data/app/graphql/examples/all_tasks.graphql +22 -0
- data/app/graphql/examples/pending_tasks.graphql +23 -0
- data/app/graphql/tasker/graph_ql_types/annotation_type.rb +14 -0
- data/app/graphql/tasker/graph_ql_types/base_argument.rb +9 -0
- data/app/graphql/tasker/graph_ql_types/base_connection.rb +11 -0
- data/app/graphql/tasker/graph_ql_types/base_edge.rb +10 -0
- data/app/graphql/tasker/graph_ql_types/base_enum.rb +9 -0
- data/app/graphql/tasker/graph_ql_types/base_field.rb +10 -0
- data/app/graphql/tasker/graph_ql_types/base_input_object.rb +10 -0
- data/app/graphql/tasker/graph_ql_types/base_interface.rb +14 -0
- data/app/graphql/tasker/graph_ql_types/base_object.rb +10 -0
- data/app/graphql/tasker/graph_ql_types/base_scalar.rb +9 -0
- data/app/graphql/tasker/graph_ql_types/base_union.rb +11 -0
- data/app/graphql/tasker/graph_ql_types/dependent_system_object_map_type.rb +18 -0
- data/app/graphql/tasker/graph_ql_types/dependent_system_type.rb +13 -0
- data/app/graphql/tasker/graph_ql_types/mutation_type.rb +16 -0
- data/app/graphql/tasker/graph_ql_types/named_step_type.rb +16 -0
- data/app/graphql/tasker/graph_ql_types/named_task_type.rb +14 -0
- data/app/graphql/tasker/graph_ql_types/named_tasks_named_step_type.rb +19 -0
- data/app/graphql/tasker/graph_ql_types/node_type.rb +12 -0
- data/app/graphql/tasker/graph_ql_types/query_type.rb +20 -0
- data/app/graphql/tasker/graph_ql_types/task_annotation_type.rb +17 -0
- data/app/graphql/tasker/graph_ql_types/task_interface.rb +17 -0
- data/app/graphql/tasker/graph_ql_types/task_type.rb +26 -0
- data/app/graphql/tasker/graph_ql_types/workflow_step_type.rb +154 -0
- data/app/graphql/tasker/graph_ql_types.rb +42 -0
- data/app/graphql/tasker/mutations/base_mutation.rb +13 -0
- data/app/graphql/tasker/mutations/cancel_step.rb +29 -0
- data/app/graphql/tasker/mutations/cancel_task.rb +29 -0
- data/app/graphql/tasker/mutations/create_task.rb +52 -0
- data/app/graphql/tasker/mutations/update_step.rb +36 -0
- data/app/graphql/tasker/mutations/update_task.rb +41 -0
- data/app/graphql/tasker/queries/all_annotation_types.rb +17 -0
- data/app/graphql/tasker/queries/all_tasks.rb +23 -0
- data/app/graphql/tasker/queries/base_query.rb +9 -0
- data/app/graphql/tasker/queries/helpers.rb +16 -0
- data/app/graphql/tasker/queries/one_step.rb +24 -0
- data/app/graphql/tasker/queries/one_task.rb +18 -0
- data/app/graphql/tasker/queries/tasks_by_annotation.rb +31 -0
- data/app/graphql/tasker/queries/tasks_by_status.rb +30 -0
- data/app/graphql/tasker/tasker_rails_schema.rb +52 -0
- data/app/jobs/tasker/application_job.rb +8 -0
- data/app/jobs/tasker/metrics_export_job.rb +252 -0
- data/app/jobs/tasker/task_runner_job.rb +224 -0
- data/app/models/tasker/annotation_type.rb +26 -0
- data/app/models/tasker/application_record.rb +70 -0
- data/app/models/tasker/dependent_system.rb +26 -0
- data/app/models/tasker/dependent_system_object_map.rb +64 -0
- data/app/models/tasker/diagram/edge.rb +106 -0
- data/app/models/tasker/diagram/flowchart.rb +137 -0
- data/app/models/tasker/diagram/node.rb +99 -0
- data/app/models/tasker/named_step.rb +41 -0
- data/app/models/tasker/named_task.rb +121 -0
- data/app/models/tasker/named_tasks_named_step.rb +82 -0
- data/app/models/tasker/step_dag_relationship.rb +65 -0
- data/app/models/tasker/step_readiness_status.rb +59 -0
- data/app/models/tasker/task.rb +424 -0
- data/app/models/tasker/task_annotation.rb +36 -0
- data/app/models/tasker/task_diagram.rb +332 -0
- data/app/models/tasker/task_execution_context.rb +29 -0
- data/app/models/tasker/task_namespace.rb +41 -0
- data/app/models/tasker/task_transition.rb +235 -0
- data/app/models/tasker/workflow_step.rb +461 -0
- data/app/models/tasker/workflow_step_edge.rb +94 -0
- data/app/models/tasker/workflow_step_transition.rb +434 -0
- data/app/serializers/tasker/annotation_type_serializer.rb +8 -0
- data/app/serializers/tasker/handler_serializer.rb +109 -0
- data/app/serializers/tasker/task_annotation_serializer.rb +32 -0
- data/app/serializers/tasker/task_serializer.rb +168 -0
- data/app/serializers/tasker/workflow_step_serializer.rb +27 -0
- data/app/services/tasker/analytics_service.rb +409 -0
- data/app/views/tasker/task/_diagram.html.erb +32 -0
- data/config/initializers/dry_struct.rb +11 -0
- data/config/initializers/statesman.rb +6 -0
- data/config/initializers/tasker_orchestration.rb +17 -0
- data/config/initializers/time_formats.rb +4 -0
- data/config/routes.rb +34 -0
- data/config/tasker/subscriptions/example_integrations.yml +67 -0
- data/config/tasker/system_events.yml +305 -0
- data/db/functions/calculate_dependency_levels_v01.sql +45 -0
- data/db/functions/get_analytics_metrics_v01.sql +137 -0
- data/db/functions/get_slowest_steps_v01.sql +82 -0
- data/db/functions/get_slowest_tasks_v01.sql +96 -0
- data/db/functions/get_step_readiness_status_batch_v01.sql +140 -0
- data/db/functions/get_step_readiness_status_v01.sql +139 -0
- data/db/functions/get_system_health_counts_v01.sql +108 -0
- data/db/functions/get_task_execution_context_v01.sql +108 -0
- data/db/functions/get_task_execution_contexts_batch_v01.sql +104 -0
- data/db/init/schema.sql +2277 -0
- data/db/migrate/20250701165431_initial_tasker_schema.rb +116 -0
- data/db/views/tasker_step_dag_relationships_v01.sql +69 -0
- data/docs/APPLICATION_GENERATOR.md +384 -0
- data/docs/AUTH.md +1780 -0
- data/docs/CIRCUIT_BREAKER.md +224 -0
- data/docs/DEVELOPER_GUIDE.md +2665 -0
- data/docs/EVENT_SYSTEM.md +637 -0
- data/docs/EXECUTION_CONFIGURATION.md +341 -0
- data/docs/FLOW_CHART.md +149 -0
- data/docs/HEALTH.md +542 -0
- data/docs/METRICS.md +731 -0
- data/docs/OPTIMIZATION_PLAN.md +1479 -0
- data/docs/OVERVIEW.md +552 -0
- data/docs/QUICK_START.md +270 -0
- data/docs/REGISTRY_SYSTEMS.md +373 -0
- data/docs/REST_API.md +632 -0
- data/docs/ROADMAP.md +221 -0
- data/docs/SQL_FUNCTIONS.md +1408 -0
- data/docs/TASK_DIAGRAM.md +252 -0
- data/docs/TASK_EXECUTION_CONTROL_FLOW.md +237 -0
- data/docs/TELEMETRY.md +795 -0
- data/docs/TROUBLESHOOTING.md +756 -0
- data/docs/TaskHandlerGenerator.html +255 -0
- data/docs/Tasker/Analysis/RuntimeGraphAnalyzer.html +907 -0
- data/docs/Tasker/Analysis/TemplateGraphAnalyzer.html +1236 -0
- data/docs/Tasker/Analysis.html +117 -0
- data/docs/Tasker/AnalyticsController.html +450 -0
- data/docs/Tasker/AnalyticsService/BottleneckAnalytics.html +816 -0
- data/docs/Tasker/AnalyticsService/PerformanceAnalytics.html +586 -0
- data/docs/Tasker/AnalyticsService.html +2221 -0
- data/docs/Tasker/AnnotationType.html +137 -0
- data/docs/Tasker/AnnotationTypeSerializer.html +124 -0
- data/docs/Tasker/ApplicationController.html +147 -0
- data/docs/Tasker/ApplicationJob.html +128 -0
- data/docs/Tasker/ApplicationRecord.html +378 -0
- data/docs/Tasker/Authentication/AuthenticationError.html +124 -0
- data/docs/Tasker/Authentication/ConfigurationError.html +124 -0
- data/docs/Tasker/Authentication/Coordinator.html +242 -0
- data/docs/Tasker/Authentication/Interface.html +560 -0
- data/docs/Tasker/Authentication/InterfaceError.html +124 -0
- data/docs/Tasker/Authentication/NoneAuthenticator.html +338 -0
- data/docs/Tasker/Authentication.html +119 -0
- data/docs/Tasker/Authorization/AuthorizationError.html +139 -0
- data/docs/Tasker/Authorization/BaseCoordinator.html +927 -0
- data/docs/Tasker/Authorization/ConfigurationError.html +153 -0
- data/docs/Tasker/Authorization/ResourceConstants/ACTIONS.html +428 -0
- data/docs/Tasker/Authorization/ResourceConstants/RESOURCES.html +365 -0
- data/docs/Tasker/Authorization/ResourceConstants.html +146 -0
- data/docs/Tasker/Authorization/ResourceRegistry.html +882 -0
- data/docs/Tasker/Authorization/UnauthorizedError.html +153 -0
- data/docs/Tasker/Authorization.html +582 -0
- data/docs/Tasker/CacheCapabilities.html +167 -0
- data/docs/Tasker/CacheStrategy.html +1297 -0
- data/docs/Tasker/Concerns/Authenticatable.html +116 -0
- data/docs/Tasker/Concerns/Authorizable/AdminStatusChecker.html +256 -0
- data/docs/Tasker/Concerns/Authorizable.html +816 -0
- data/docs/Tasker/Concerns/ControllerAuthorizable.html +157 -0
- data/docs/Tasker/Concerns/EventPublisher.html +4023 -0
- data/docs/Tasker/Concerns/IdempotentStateTransitions.html +806 -0
- data/docs/Tasker/Concerns/LifecycleEventHelpers.html +129 -0
- data/docs/Tasker/Concerns/OrchestrationPublisher.html +129 -0
- data/docs/Tasker/Concerns/StateMachineBase/ClassMethods.html +1075 -0
- data/docs/Tasker/Concerns/StateMachineBase/StateMachineBase/ClassMethods.html +191 -0
- data/docs/Tasker/Concerns/StateMachineBase/StateMachineBase.html +126 -0
- data/docs/Tasker/Concerns/StateMachineBase.html +153 -0
- data/docs/Tasker/Concerns/StructuredLogging.html +1413 -0
- data/docs/Tasker/Concerns.html +117 -0
- data/docs/Tasker/Configuration/AuthConfiguration.html +1023 -0
- data/docs/Tasker/Configuration/ConfigurationProxy.html +581 -0
- data/docs/Tasker/Configuration/DatabaseConfiguration.html +475 -0
- data/docs/Tasker/Configuration/EngineConfiguration.html +1265 -0
- data/docs/Tasker/Configuration/HealthConfiguration.html +791 -0
- data/docs/Tasker/Configuration/TelemetryConfiguration.html +1308 -0
- data/docs/Tasker/Configuration/TelemetryConfigurationProxy.html +388 -0
- data/docs/Tasker/Configuration.html +1669 -0
- data/docs/Tasker/ConfigurationError.html +143 -0
- data/docs/Tasker/ConfiguredTask.html +514 -0
- data/docs/Tasker/Constants/EventDefinitions.html +590 -0
- data/docs/Tasker/Constants/LifecycleEvents.html +137 -0
- data/docs/Tasker/Constants/ObservabilityEvents/Step.html +152 -0
- data/docs/Tasker/Constants/ObservabilityEvents/Task.html +142 -0
- data/docs/Tasker/Constants/ObservabilityEvents.html +126 -0
- data/docs/Tasker/Constants/RegistryEvents.html +285 -0
- data/docs/Tasker/Constants/StepEvents.html +177 -0
- data/docs/Tasker/Constants/TaskEvents.html +167 -0
- data/docs/Tasker/Constants/TaskExecution/ExecutionStatus.html +207 -0
- data/docs/Tasker/Constants/TaskExecution/HealthStatus.html +191 -0
- data/docs/Tasker/Constants/TaskExecution/RecommendedAction.html +207 -0
- data/docs/Tasker/Constants/TaskExecution.html +126 -0
- data/docs/Tasker/Constants/TaskFinalization/ErrorMessages.html +132 -0
- data/docs/Tasker/Constants/TaskFinalization/PendingReasons.html +207 -0
- data/docs/Tasker/Constants/TaskFinalization/ReenqueueReasons.html +239 -0
- data/docs/Tasker/Constants/TaskFinalization.html +126 -0
- data/docs/Tasker/Constants/TaskStatuses.html +223 -0
- data/docs/Tasker/Constants/TestEvents.html +163 -0
- data/docs/Tasker/Constants/WorkflowEvents.html +222 -0
- data/docs/Tasker/Constants/WorkflowStepStatuses.html +223 -0
- data/docs/Tasker/Constants.html +561 -0
- data/docs/Tasker/DependentSystem.html +137 -0
- data/docs/Tasker/DependentSystemObjectMap.html +250 -0
- data/docs/Tasker/DetectorRegistry.html +598 -0
- data/docs/Tasker/Diagram/Edge.html +1191 -0
- data/docs/Tasker/Diagram/Flowchart.html +1539 -0
- data/docs/Tasker/Diagram/Node.html +1165 -0
- data/docs/Tasker/Diagram.html +117 -0
- data/docs/Tasker/Engine.html +215 -0
- data/docs/Tasker/Error.html +139 -0
- data/docs/Tasker/Events/Bus.html +1226 -0
- data/docs/Tasker/Events/Catalog/CatalogPrinter.html +258 -0
- data/docs/Tasker/Events/Catalog/CustomEventRegistrar.html +276 -0
- data/docs/Tasker/Events/Catalog/ExamplePayloadGenerator.html +294 -0
- data/docs/Tasker/Events/Catalog.html +1291 -0
- data/docs/Tasker/Events/CustomRegistry.html +943 -0
- data/docs/Tasker/Events/DefinitionLoader.html +575 -0
- data/docs/Tasker/Events/EventPayloadBuilder/ErrorInfoExtractor.html +286 -0
- data/docs/Tasker/Events/EventPayloadBuilder/StepPayloadBuilder.html +312 -0
- data/docs/Tasker/Events/EventPayloadBuilder.html +664 -0
- data/docs/Tasker/Events/Publisher.html +365 -0
- data/docs/Tasker/Events/Subscribers/BaseSubscriber/ErrorCategorizer/ErrorTypeClassifier.html +1128 -0
- data/docs/Tasker/Events/Subscribers/BaseSubscriber/ErrorCategorizer.html +270 -0
- data/docs/Tasker/Events/Subscribers/BaseSubscriber/MetricTagsExtractor.html +266 -0
- data/docs/Tasker/Events/Subscribers/BaseSubscriber.html +2556 -0
- data/docs/Tasker/Events/Subscribers/MetricsSubscriber.html +723 -0
- data/docs/Tasker/Events/Subscribers/TelemetrySubscriber.html +2251 -0
- data/docs/Tasker/Events/Subscribers.html +117 -0
- data/docs/Tasker/Events/SubscriptionLoader.html +493 -0
- data/docs/Tasker/Events.html +294 -0
- data/docs/Tasker/EventsGenerator.html +459 -0
- data/docs/Tasker/Functions/FunctionBasedAnalyticsMetrics/AnalyticsMetrics.html +135 -0
- data/docs/Tasker/Functions/FunctionBasedAnalyticsMetrics.html +412 -0
- data/docs/Tasker/Functions/FunctionBasedDependencyLevels.html +598 -0
- data/docs/Tasker/Functions/FunctionBasedSlowestSteps/SlowestStep.html +135 -0
- data/docs/Tasker/Functions/FunctionBasedSlowestSteps.html +453 -0
- data/docs/Tasker/Functions/FunctionBasedSlowestTasks/SlowestTask.html +135 -0
- data/docs/Tasker/Functions/FunctionBasedSlowestTasks.html +453 -0
- data/docs/Tasker/Functions/FunctionBasedStepReadinessStatus.html +1457 -0
- data/docs/Tasker/Functions/FunctionBasedSystemHealthCounts/HealthMetrics.html +135 -0
- data/docs/Tasker/Functions/FunctionBasedSystemHealthCounts.html +370 -0
- data/docs/Tasker/Functions/FunctionBasedTaskExecutionContext.html +1250 -0
- data/docs/Tasker/Functions/FunctionWrapper.html +479 -0
- data/docs/Tasker/Functions.html +117 -0
- data/docs/Tasker/Generators/AuthenticatorGenerator/UsageInstructionsFormatter.html +244 -0
- data/docs/Tasker/Generators/AuthenticatorGenerator.html +373 -0
- data/docs/Tasker/Generators/AuthorizationCoordinatorGenerator.html +430 -0
- data/docs/Tasker/Generators/SubscriberGenerator.html +377 -0
- data/docs/Tasker/Generators/TaskHandlerGenerator.html +263 -0
- data/docs/Tasker/Generators.html +117 -0
- data/docs/Tasker/GraphQLTypes/AnnotationType.html +132 -0
- data/docs/Tasker/GraphQLTypes/BaseArgument.html +124 -0
- data/docs/Tasker/GraphQLTypes/BaseConnection.html +124 -0
- data/docs/Tasker/GraphQLTypes/BaseEdge.html +130 -0
- data/docs/Tasker/GraphQLTypes/BaseEnum.html +124 -0
- data/docs/Tasker/GraphQLTypes/BaseField.html +124 -0
- data/docs/Tasker/GraphQLTypes/BaseInputObject.html +124 -0
- data/docs/Tasker/GraphQLTypes/BaseInterface.html +116 -0
- data/docs/Tasker/GraphQLTypes/BaseObject.html +128 -0
- data/docs/Tasker/GraphQLTypes/BaseScalar.html +124 -0
- data/docs/Tasker/GraphQLTypes/BaseUnion.html +124 -0
- data/docs/Tasker/GraphQLTypes/DependentSystemObjectMapType.html +132 -0
- data/docs/Tasker/GraphQLTypes/DependentSystemType.html +132 -0
- data/docs/Tasker/GraphQLTypes/MutationType.html +132 -0
- data/docs/Tasker/GraphQLTypes/NamedStepType.html +132 -0
- data/docs/Tasker/GraphQLTypes/NamedTaskType.html +132 -0
- data/docs/Tasker/GraphQLTypes/NamedTasksNamedStepType.html +132 -0
- data/docs/Tasker/GraphQLTypes/NodeType.html +118 -0
- data/docs/Tasker/GraphQLTypes/QueryType.html +139 -0
- data/docs/Tasker/GraphQLTypes/TaskAnnotationType.html +132 -0
- data/docs/Tasker/GraphQLTypes/TaskInterface.html +111 -0
- data/docs/Tasker/GraphQLTypes/TaskType.html +201 -0
- data/docs/Tasker/GraphQLTypes/WorkflowStepType.html +694 -0
- data/docs/Tasker/GraphQLTypes.html +130 -0
- data/docs/Tasker/GraphqlController.html +251 -0
- data/docs/Tasker/HandlerFactory.html +1518 -0
- data/docs/Tasker/HandlerSerializer.html +682 -0
- data/docs/Tasker/HandlersController.html +574 -0
- data/docs/Tasker/HashIdentityStrategy.html +278 -0
- data/docs/Tasker/Health/ReadinessChecker.html +712 -0
- data/docs/Tasker/Health/StatusChecker.html +653 -0
- data/docs/Tasker/Health.html +117 -0
- data/docs/Tasker/HealthController.html +523 -0
- data/docs/Tasker/IdentityStrategy.html +276 -0
- data/docs/Tasker/InvalidTaskHandlerConfig.html +135 -0
- data/docs/Tasker/LifecycleEvents/Events/Step.html +162 -0
- data/docs/Tasker/LifecycleEvents/Events/Task.html +162 -0
- data/docs/Tasker/LifecycleEvents/Events.html +204 -0
- data/docs/Tasker/LifecycleEvents/Publisher.html +132 -0
- data/docs/Tasker/LifecycleEvents.html +799 -0
- data/docs/Tasker/Logging/CorrelationIdGenerator.html +688 -0
- data/docs/Tasker/Logging.html +115 -0
- data/docs/Tasker/MetricsController.html +293 -0
- data/docs/Tasker/MetricsExportJob.html +414 -0
- data/docs/Tasker/Mutations/BaseMutation.html +128 -0
- data/docs/Tasker/Mutations/CancelStep.html +219 -0
- data/docs/Tasker/Mutations/CancelTask.html +221 -0
- data/docs/Tasker/Mutations/CreateTask.html +243 -0
- data/docs/Tasker/Mutations/UpdateStep.html +243 -0
- data/docs/Tasker/Mutations/UpdateTask.html +243 -0
- data/docs/Tasker/Mutations.html +117 -0
- data/docs/Tasker/NamedStep.html +216 -0
- data/docs/Tasker/NamedTask.html +910 -0
- data/docs/Tasker/NamedTasksNamedStep.html +435 -0
- data/docs/Tasker/Orchestration/BackoffCalculator.html +404 -0
- data/docs/Tasker/Orchestration/ConnectionBuilder/ConfigValidator.html +258 -0
- data/docs/Tasker/Orchestration/ConnectionBuilder.html +435 -0
- data/docs/Tasker/Orchestration/ConnectionPoolIntelligence.html +513 -0
- data/docs/Tasker/Orchestration/Coordinator.html +641 -0
- data/docs/Tasker/Orchestration/FutureStateAnalyzer.html +1045 -0
- data/docs/Tasker/Orchestration/Orchestrator.html +679 -0
- data/docs/Tasker/Orchestration/PluginIntegration.html +1127 -0
- data/docs/Tasker/Orchestration/ResponseProcessor.html +504 -0
- data/docs/Tasker/Orchestration/RetryHeaderParser.html +304 -0
- data/docs/Tasker/Orchestration/StepExecutor.html +995 -0
- data/docs/Tasker/Orchestration/StepSequenceFactory.html +644 -0
- data/docs/Tasker/Orchestration/TaskFinalizer/BlockageChecker.html +264 -0
- data/docs/Tasker/Orchestration/TaskFinalizer/ContextManager.html +254 -0
- data/docs/Tasker/Orchestration/TaskFinalizer/DelayCalculator.html +556 -0
- data/docs/Tasker/Orchestration/TaskFinalizer/FinalizationDecisionMaker.html +348 -0
- data/docs/Tasker/Orchestration/TaskFinalizer/FinalizationProcessor.html +286 -0
- data/docs/Tasker/Orchestration/TaskFinalizer/ReasonDeterminer.html +432 -0
- data/docs/Tasker/Orchestration/TaskFinalizer/ReenqueueManager.html +296 -0
- data/docs/Tasker/Orchestration/TaskFinalizer/UnclearStateHandler.html +314 -0
- data/docs/Tasker/Orchestration/TaskFinalizer.html +1212 -0
- data/docs/Tasker/Orchestration/TaskInitializer.html +766 -0
- data/docs/Tasker/Orchestration/TaskReenqueuer.html +506 -0
- data/docs/Tasker/Orchestration/ViableStepDiscovery.html +442 -0
- data/docs/Tasker/Orchestration/WorkflowCoordinator.html +510 -0
- data/docs/Tasker/Orchestration.html +130 -0
- data/docs/Tasker/PageSort/PageSortParamsBuilder.html +296 -0
- data/docs/Tasker/PageSort.html +247 -0
- data/docs/Tasker/PermanentError.html +518 -0
- data/docs/Tasker/ProceduralError.html +147 -0
- data/docs/Tasker/Queries/AllAnnotationTypes.html +217 -0
- data/docs/Tasker/Queries/AllTasks.html +221 -0
- data/docs/Tasker/Queries/BaseQuery.html +128 -0
- data/docs/Tasker/Queries/Helpers.html +187 -0
- data/docs/Tasker/Queries/OneStep.html +225 -0
- data/docs/Tasker/Queries/OneTask.html +217 -0
- data/docs/Tasker/Queries/TasksByAnnotation.html +231 -0
- data/docs/Tasker/Queries/TasksByStatus.html +233 -0
- data/docs/Tasker/Queries.html +119 -0
- data/docs/Tasker/Railtie.html +124 -0
- data/docs/Tasker/Registry/BaseRegistry.html +1690 -0
- data/docs/Tasker/Registry/EventPublisher.html +667 -0
- data/docs/Tasker/Registry/InterfaceValidator.html +569 -0
- data/docs/Tasker/Registry/RegistrationError.html +132 -0
- data/docs/Tasker/Registry/RegistryError.html +139 -0
- data/docs/Tasker/Registry/StatisticsCollector.html +841 -0
- data/docs/Tasker/Registry/SubscriberRegistry.html +1504 -0
- data/docs/Tasker/Registry/ValidationError.html +132 -0
- data/docs/Tasker/Registry.html +119 -0
- data/docs/Tasker/RetryableError.html +515 -0
- data/docs/Tasker/StateMachine/Compatibility.html +282 -0
- data/docs/Tasker/StateMachine/InvalidStateTransition.html +135 -0
- data/docs/Tasker/StateMachine/StepStateMachine/StandardizedPayloadBuilder.html +260 -0
- data/docs/Tasker/StateMachine/StepStateMachine.html +2215 -0
- data/docs/Tasker/StateMachine/TaskStateMachine.html +734 -0
- data/docs/Tasker/StateMachine.html +602 -0
- data/docs/Tasker/StepDagRelationship.html +657 -0
- data/docs/Tasker/StepHandler/Api/Config.html +1091 -0
- data/docs/Tasker/StepHandler/Api.html +884 -0
- data/docs/Tasker/StepHandler/AutomaticEventPublishing.html +321 -0
- data/docs/Tasker/StepHandler/Base.html +970 -0
- data/docs/Tasker/StepHandler.html +119 -0
- data/docs/Tasker/StepReadinessStatus.html +836 -0
- data/docs/Tasker/Task.html +2575 -0
- data/docs/Tasker/TaskAnnotation.html +137 -0
- data/docs/Tasker/TaskAnnotationSerializer.html +124 -0
- data/docs/Tasker/TaskBuilder/StepNameValidator.html +264 -0
- data/docs/Tasker/TaskBuilder/StepTemplateDefiner.html +264 -0
- data/docs/Tasker/TaskBuilder.html +764 -0
- data/docs/Tasker/TaskDiagram/StepToStepEdgeBuilder.html +260 -0
- data/docs/Tasker/TaskDiagram/TaskToRootStepEdgeBuilder.html +290 -0
- data/docs/Tasker/TaskDiagram.html +548 -0
- data/docs/Tasker/TaskDiagramsController.html +240 -0
- data/docs/Tasker/TaskExecutionContext.html +469 -0
- data/docs/Tasker/TaskHandler/ClassMethods/StepTemplateDefiner/ClassBasedEventRegistrar.html +238 -0
- data/docs/Tasker/TaskHandler/ClassMethods/StepTemplateDefiner/YamlEventRegistrar.html +254 -0
- data/docs/Tasker/TaskHandler/ClassMethods/StepTemplateDefiner.html +988 -0
- data/docs/Tasker/TaskHandler/ClassMethods.html +357 -0
- data/docs/Tasker/TaskHandler/InstanceMethods.html +1396 -0
- data/docs/Tasker/TaskHandler/StepGroup.html +1748 -0
- data/docs/Tasker/TaskHandler.html +271 -0
- data/docs/Tasker/TaskNamespace.html +312 -0
- data/docs/Tasker/TaskRunnerJob.html +406 -0
- data/docs/Tasker/TaskSerializer.html +474 -0
- data/docs/Tasker/TaskTransition.html +1517 -0
- data/docs/Tasker/TaskWorkflowSummary.html +988 -0
- data/docs/Tasker/TaskerRailsSchema/InvalidObjectTypeError.html +132 -0
- data/docs/Tasker/TaskerRailsSchema/TypeResolutionError.html +139 -0
- data/docs/Tasker/TaskerRailsSchema/UnknownInterfaceError.html +132 -0
- data/docs/Tasker/TaskerRailsSchema.html +384 -0
- data/docs/Tasker/TasksController.html +595 -0
- data/docs/Tasker/Telemetry/EventMapping.html +1307 -0
- data/docs/Tasker/Telemetry/EventRouter.html +2178 -0
- data/docs/Tasker/Telemetry/Events/ExportEvents.html +246 -0
- data/docs/Tasker/Telemetry/Events.html +115 -0
- data/docs/Tasker/Telemetry/ExportCoordinator/DistributedLockTimeoutError.html +135 -0
- data/docs/Tasker/Telemetry/ExportCoordinator.html +2137 -0
- data/docs/Tasker/Telemetry/IntelligentCacheManager.html +1083 -0
- data/docs/Tasker/Telemetry/LogBackend.html +1088 -0
- data/docs/Tasker/Telemetry/MetricTypes/Counter.html +1054 -0
- data/docs/Tasker/Telemetry/MetricTypes/Gauge.html +1270 -0
- data/docs/Tasker/Telemetry/MetricTypes/Histogram.html +1492 -0
- data/docs/Tasker/Telemetry/MetricTypes.html +153 -0
- data/docs/Tasker/Telemetry/MetricsBackend.html +2510 -0
- data/docs/Tasker/Telemetry/MetricsExportService.html +578 -0
- data/docs/Tasker/Telemetry/PluginRegistry.html +1774 -0
- data/docs/Tasker/Telemetry/Plugins/BaseExporter.html +1835 -0
- data/docs/Tasker/Telemetry/Plugins/CsvExporter.html +768 -0
- data/docs/Tasker/Telemetry/Plugins/JsonExporter.html +747 -0
- data/docs/Tasker/Telemetry/Plugins.html +117 -0
- data/docs/Tasker/Telemetry/PrometheusExporter.html +481 -0
- data/docs/Tasker/Telemetry/TraceBackend.html +891 -0
- data/docs/Tasker/Telemetry.html +130 -0
- data/docs/Tasker/Types/AuthConfig.html +886 -0
- data/docs/Tasker/Types/BackoffConfig.html +1063 -0
- data/docs/Tasker/Types/BaseConfig.html +227 -0
- data/docs/Tasker/Types/CacheConfig.html +1731 -0
- data/docs/Tasker/Types/DatabaseConfig.html +388 -0
- data/docs/Tasker/Types/DependencyGraph.html +526 -0
- data/docs/Tasker/Types/DependencyGraphConfig.html +753 -0
- data/docs/Tasker/Types/EngineConfig.html +1181 -0
- data/docs/Tasker/Types/ExecutionConfig.html +1963 -0
- data/docs/Tasker/Types/GraphEdge.html +517 -0
- data/docs/Tasker/Types/GraphMetadata.html +781 -0
- data/docs/Tasker/Types/GraphNode.html +694 -0
- data/docs/Tasker/Types/HealthConfig.html +784 -0
- data/docs/Tasker/Types/StepSequence.html +353 -0
- data/docs/Tasker/Types/StepTemplate.html +1193 -0
- data/docs/Tasker/Types/TaskRequest.html +1179 -0
- data/docs/Tasker/Types/TelemetryConfig.html +2746 -0
- data/docs/Tasker/Types.html +154 -0
- data/docs/Tasker/WorkflowStep/StepFinder.html +282 -0
- data/docs/Tasker/WorkflowStep.html +2724 -0
- data/docs/Tasker/WorkflowStepEdge.html +304 -0
- data/docs/Tasker/WorkflowStepSerializer.html +305 -0
- data/docs/Tasker/WorkflowStepTransition/TransitionDescriptionFormatter.html +282 -0
- data/docs/Tasker/WorkflowStepTransition.html +2201 -0
- data/docs/Tasker/WorkflowStepsController.html +462 -0
- data/docs/Tasker.html +452 -0
- data/docs/VISION.md +584 -0
- data/docs/WHY.md +21 -0
- data/docs/_index.html +2375 -0
- data/docs/class_list.html +54 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +503 -0
- data/docs/events/migration_plan_outcomes.md +80 -0
- data/docs/file.README.html +541 -0
- data/docs/file_list.html +59 -0
- data/docs/frames.html +22 -0
- data/docs/index.html +541 -0
- data/docs/js/app.js +344 -0
- data/docs/js/full_list.js +242 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +9182 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/generators/tasker/authenticator_generator.rb +301 -0
- data/lib/generators/tasker/authorization_coordinator_generator.rb +139 -0
- data/lib/generators/tasker/events_generator.rb +91 -0
- data/lib/generators/tasker/subscriber_generator.rb +107 -0
- data/lib/generators/tasker/task_handler_generator.rb +138 -0
- data/lib/generators/tasker/templates/api_token_authenticator.rb.erb +113 -0
- data/lib/generators/tasker/templates/api_token_authenticator_spec.rb.erb +144 -0
- data/lib/generators/tasker/templates/authorization_coordinator.rb.erb +95 -0
- data/lib/generators/tasker/templates/authorization_coordinator_spec.rb.erb +142 -0
- data/lib/generators/tasker/templates/custom_authenticator.rb.erb +108 -0
- data/lib/generators/tasker/templates/custom_authenticator_spec.rb.erb +162 -0
- data/lib/generators/tasker/templates/custom_events.yml.erb +62 -0
- data/lib/generators/tasker/templates/custom_subscriber.rb.erb +72 -0
- data/lib/generators/tasker/templates/devise_authenticator.rb.erb +101 -0
- data/lib/generators/tasker/templates/devise_authenticator_spec.rb.erb +126 -0
- data/lib/generators/tasker/templates/initialize.rb.erb +202 -0
- data/lib/generators/tasker/templates/jwt_authenticator.rb.erb +144 -0
- data/lib/generators/tasker/templates/jwt_authenticator_spec.rb.erb +298 -0
- data/lib/generators/tasker/templates/metrics_subscriber.rb.erb +258 -0
- data/lib/generators/tasker/templates/metrics_subscriber_spec.rb.erb +308 -0
- data/lib/generators/tasker/templates/omniauth_authenticator.rb.erb +135 -0
- data/lib/generators/tasker/templates/omniauth_authenticator_spec.rb.erb +196 -0
- data/lib/generators/tasker/templates/opentelemetry_initializer.rb +52 -0
- data/lib/generators/tasker/templates/subscriber.rb.erb +64 -0
- data/lib/generators/tasker/templates/subscriber_spec.rb.erb +80 -0
- data/lib/generators/tasker/templates/task_config.yaml.erb +117 -0
- data/lib/generators/tasker/templates/task_handler.rb.erb +59 -0
- data/lib/generators/tasker/templates/task_handler_spec.rb.erb +159 -0
- data/lib/tasker/analysis/runtime_graph_analyzer.rb +1168 -0
- data/lib/tasker/analysis/template_graph_analyzer.rb +328 -0
- data/lib/tasker/authentication/coordinator.rb +78 -0
- data/lib/tasker/authentication/errors.rb +9 -0
- data/lib/tasker/authentication/interface.rb +36 -0
- data/lib/tasker/authentication/none_authenticator.rb +26 -0
- data/lib/tasker/authorization/base_coordinator.rb +112 -0
- data/lib/tasker/authorization/errors.rb +26 -0
- data/lib/tasker/authorization/resource_constants.rb +74 -0
- data/lib/tasker/authorization/resource_registry.rb +143 -0
- data/lib/tasker/authorization.rb +75 -0
- data/lib/tasker/cache_capabilities.rb +131 -0
- data/lib/tasker/cache_strategy.rb +469 -0
- data/lib/tasker/concerns/authenticatable.rb +41 -0
- data/lib/tasker/concerns/authorizable.rb +204 -0
- data/lib/tasker/concerns/controller_authorizable.rb +124 -0
- data/lib/tasker/concerns/event_publisher.rb +716 -0
- data/lib/tasker/concerns/idempotent_state_transitions.rb +128 -0
- data/lib/tasker/concerns/state_machine_base.rb +218 -0
- data/lib/tasker/concerns/structured_logging.rb +387 -0
- data/lib/tasker/configuration.rb +325 -0
- data/lib/tasker/constants/event_definitions.rb +147 -0
- data/lib/tasker/constants/registry_events.rb +54 -0
- data/lib/tasker/constants.rb +417 -0
- data/lib/tasker/engine.rb +90 -0
- data/lib/tasker/errors.rb +90 -0
- data/lib/tasker/events/catalog.rb +432 -0
- data/lib/tasker/events/custom_registry.rb +175 -0
- data/lib/tasker/events/definition_loader.rb +199 -0
- data/lib/tasker/events/event_payload_builder.rb +461 -0
- data/lib/tasker/events/publisher.rb +149 -0
- data/lib/tasker/events/subscribers/base_subscriber.rb +601 -0
- data/lib/tasker/events/subscribers/metrics_subscriber.rb +120 -0
- data/lib/tasker/events/subscribers/telemetry_subscriber.rb +462 -0
- data/lib/tasker/events/subscription_loader.rb +161 -0
- data/lib/tasker/events.rb +37 -0
- data/lib/tasker/functions/function_based_analytics_metrics.rb +103 -0
- data/lib/tasker/functions/function_based_dependency_levels.rb +54 -0
- data/lib/tasker/functions/function_based_slowest_steps.rb +84 -0
- data/lib/tasker/functions/function_based_slowest_tasks.rb +84 -0
- data/lib/tasker/functions/function_based_step_readiness_status.rb +183 -0
- data/lib/tasker/functions/function_based_system_health_counts.rb +94 -0
- data/lib/tasker/functions/function_based_task_execution_context.rb +148 -0
- data/lib/tasker/functions/function_wrapper.rb +42 -0
- data/lib/tasker/functions.rb +12 -0
- data/lib/tasker/handler_factory.rb +322 -0
- data/lib/tasker/health/readiness_checker.rb +186 -0
- data/lib/tasker/health/status_checker.rb +203 -0
- data/lib/tasker/identity_strategy.rb +38 -0
- data/lib/tasker/logging/correlation_id_generator.rb +120 -0
- data/lib/tasker/orchestration/backoff_calculator.rb +184 -0
- data/lib/tasker/orchestration/connection_builder.rb +122 -0
- data/lib/tasker/orchestration/connection_pool_intelligence.rb +177 -0
- data/lib/tasker/orchestration/coordinator.rb +119 -0
- data/lib/tasker/orchestration/future_state_analyzer.rb +137 -0
- data/lib/tasker/orchestration/plugin_integration.rb +124 -0
- data/lib/tasker/orchestration/response_processor.rb +168 -0
- data/lib/tasker/orchestration/retry_header_parser.rb +78 -0
- data/lib/tasker/orchestration/step_executor.rb +941 -0
- data/lib/tasker/orchestration/step_sequence_factory.rb +67 -0
- data/lib/tasker/orchestration/task_finalizer.rb +564 -0
- data/lib/tasker/orchestration/task_initializer.rb +140 -0
- data/lib/tasker/orchestration/task_reenqueuer.rb +71 -0
- data/lib/tasker/orchestration/viable_step_discovery.rb +65 -0
- data/lib/tasker/orchestration/workflow_coordinator.rb +294 -0
- data/lib/tasker/orchestration.rb +45 -0
- data/lib/tasker/railtie.rb +9 -0
- data/lib/tasker/registry/base_registry.rb +177 -0
- data/lib/tasker/registry/event_publisher.rb +91 -0
- data/lib/tasker/registry/interface_validator.rb +140 -0
- data/lib/tasker/registry/statistics_collector.rb +381 -0
- data/lib/tasker/registry/subscriber_registry.rb +285 -0
- data/lib/tasker/registry.rb +22 -0
- data/lib/tasker/state_machine/step_state_machine.rb +508 -0
- data/lib/tasker/state_machine/task_state_machine.rb +192 -0
- data/lib/tasker/state_machine.rb +83 -0
- data/lib/tasker/step_handler/api.rb +410 -0
- data/lib/tasker/step_handler/base.rb +206 -0
- data/lib/tasker/task_builder.rb +432 -0
- data/lib/tasker/task_handler/class_methods.rb +324 -0
- data/lib/tasker/task_handler/instance_methods.rb +293 -0
- data/lib/tasker/task_handler/step_group.rb +182 -0
- data/lib/tasker/task_handler.rb +43 -0
- data/lib/tasker/telemetry/event_mapping.rb +126 -0
- data/lib/tasker/telemetry/event_router.rb +318 -0
- data/lib/tasker/telemetry/events/export_events.rb +38 -0
- data/lib/tasker/telemetry/export_coordinator.rb +497 -0
- data/lib/tasker/telemetry/intelligent_cache_manager.rb +508 -0
- data/lib/tasker/telemetry/log_backend.rb +224 -0
- data/lib/tasker/telemetry/metric_types.rb +368 -0
- data/lib/tasker/telemetry/metrics_backend.rb +1227 -0
- data/lib/tasker/telemetry/metrics_export_service.rb +392 -0
- data/lib/tasker/telemetry/plugin_registry.rb +333 -0
- data/lib/tasker/telemetry/plugins/base_exporter.rb +246 -0
- data/lib/tasker/telemetry/plugins/csv_exporter.rb +198 -0
- data/lib/tasker/telemetry/plugins/json_exporter.rb +141 -0
- data/lib/tasker/telemetry/prometheus_exporter.rb +249 -0
- data/lib/tasker/telemetry/trace_backend.rb +186 -0
- data/lib/tasker/telemetry.rb +59 -0
- data/lib/tasker/types/auth_config.rb +81 -0
- data/lib/tasker/types/backoff_config.rb +142 -0
- data/lib/tasker/types/cache_config.rb +257 -0
- data/lib/tasker/types/database_config.rb +39 -0
- data/lib/tasker/types/dependency_graph.rb +225 -0
- data/lib/tasker/types/dependency_graph_config.rb +149 -0
- data/lib/tasker/types/engine_config.rb +131 -0
- data/lib/tasker/types/execution_config.rb +289 -0
- data/lib/tasker/types/health_config.rb +84 -0
- data/lib/tasker/types/step_sequence.rb +24 -0
- data/lib/tasker/types/step_template.rb +63 -0
- data/lib/tasker/types/task_request.rb +60 -0
- data/lib/tasker/types/telemetry_config.rb +273 -0
- data/lib/tasker/types.rb +64 -0
- data/lib/tasker/version.rb +7 -0
- data/lib/tasker.rb +82 -0
- data/lib/tasks/tasker_tasks.rake +302 -0
- metadata +958 -0
|
@@ -0,0 +1,1307 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: Tasker::Telemetry::EventMapping
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.37
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "Tasker::Telemetry::EventMapping";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (E)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../Tasker.html" title="Tasker (module)">Tasker</a></span></span> » <span class='title'><span class='object_link'><a href="../Telemetry.html" title="Tasker::Telemetry (module)">Telemetry</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">EventMapping</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: Tasker::Telemetry::EventMapping
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName"><span class='object_link'><a href="../Types/BaseConfig.html" title="Tasker::Types::BaseConfig (class)">Tasker::Types::BaseConfig</a></span></span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">Dry::Struct</li>
|
|
78
|
+
|
|
79
|
+
<li class="next"><span class='object_link'><a href="../Types/BaseConfig.html" title="Tasker::Types::BaseConfig (class)">Tasker::Types::BaseConfig</a></span></li>
|
|
80
|
+
|
|
81
|
+
<li class="next">Tasker::Telemetry::EventMapping</li>
|
|
82
|
+
|
|
83
|
+
</ul>
|
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
85
|
+
|
|
86
|
+
</dd>
|
|
87
|
+
</dl>
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<dl>
|
|
100
|
+
<dt>Defined in:</dt>
|
|
101
|
+
<dd>lib/tasker/telemetry/event_mapping.rb</dd>
|
|
102
|
+
</dl>
|
|
103
|
+
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
<h2>Overview</h2><div class="docstring">
|
|
107
|
+
<div class="discussion">
|
|
108
|
+
|
|
109
|
+
<p>EventMapping represents a single event→telemetry routing configuration</p>
|
|
110
|
+
|
|
111
|
+
<p>This class defines how a specific event should be routed to telemetry backends. It uses dry-struct for immutability and type safety, following the established pattern from Tasker::Types configuration classes.</p>
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
</div>
|
|
115
|
+
</div>
|
|
116
|
+
<div class="tags">
|
|
117
|
+
|
|
118
|
+
<div class="examples">
|
|
119
|
+
<h4 class="tag_title">Examples:</h4>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<h5 class="example_title"><div class='inline'>
|
|
123
|
+
<p>Basic event mapping</p>
|
|
124
|
+
</div></h5>
|
|
125
|
+
|
|
126
|
+
<pre class="example code"><code><span class='id identifier rubyid_mapping'>mapping</span> <span class='op'>=</span> <span class='const'>EventMapping</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Tasker::Telemetry::EventMapping#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
|
127
|
+
<span class='label'>event_name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>task.completed</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
128
|
+
<span class='label'>backends:</span> <span class='lbracket'>[</span><span class='symbol'>:trace</span><span class='comma'>,</span> <span class='symbol'>:metrics</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
129
|
+
<span class='label'>enabled:</span> <span class='kw'>true</span>
|
|
130
|
+
<span class='rparen'>)</span></code></pre>
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
<h5 class="example_title"><div class='inline'>
|
|
134
|
+
<p>Metrics-only mapping for operational data</p>
|
|
135
|
+
</div></h5>
|
|
136
|
+
|
|
137
|
+
<pre class="example code"><code><span class='id identifier rubyid_mapping'>mapping</span> <span class='op'>=</span> <span class='const'>EventMapping</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Tasker::Telemetry::EventMapping#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
|
138
|
+
<span class='label'>event_name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>observability.task.enqueue</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
139
|
+
<span class='label'>backends:</span> <span class='lbracket'>[</span><span class='symbol'>:metrics</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
140
|
+
<span class='label'>sampling_rate:</span> <span class='float'>1.0</span>
|
|
141
|
+
<span class='rparen'>)</span></code></pre>
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
<h5 class="example_title"><div class='inline'>
|
|
145
|
+
<p>Trace-only mapping for debugging</p>
|
|
146
|
+
</div></h5>
|
|
147
|
+
|
|
148
|
+
<pre class="example code"><code><span class='id identifier rubyid_mapping'>mapping</span> <span class='op'>=</span> <span class='const'>EventMapping</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Tasker::Telemetry::EventMapping#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
|
149
|
+
<span class='label'>event_name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>step.before_handle</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
|
150
|
+
<span class='label'>backends:</span> <span class='lbracket'>[</span><span class='symbol'>:trace</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
151
|
+
<span class='label'>sampling_rate:</span> <span class='float'>0.1</span> <span class='comment'># Sample 10% for performance
|
|
152
|
+
</span><span class='rparen'>)</span></code></pre>
|
|
153
|
+
|
|
154
|
+
</div>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
</div>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
162
|
+
<ul class="summary">
|
|
163
|
+
|
|
164
|
+
<li class="public ">
|
|
165
|
+
<span class="summary_signature">
|
|
166
|
+
|
|
167
|
+
<a href="#backends-instance_method" title="#backends (instance method)">#<strong>backends</strong> ⇒ Array<Symbol> </a>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
</span>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<span class="note title readonly">readonly</span>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<span class="summary_desc"><div class='inline'>
|
|
187
|
+
<p>List of backend types (:trace, :metrics, :logs).</p>
|
|
188
|
+
</div></span>
|
|
189
|
+
|
|
190
|
+
</li>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
<li class="public ">
|
|
194
|
+
<span class="summary_signature">
|
|
195
|
+
|
|
196
|
+
<a href="#enabled-instance_method" title="#enabled (instance method)">#<strong>enabled</strong> ⇒ Boolean </a>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
</span>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
<span class="note title readonly">readonly</span>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
<span class="summary_desc"><div class='inline'>
|
|
216
|
+
<p>True if this mapping should be processed.</p>
|
|
217
|
+
</div></span>
|
|
218
|
+
|
|
219
|
+
</li>
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<li class="public ">
|
|
223
|
+
<span class="summary_signature">
|
|
224
|
+
|
|
225
|
+
<a href="#event_name-instance_method" title="#event_name (instance method)">#<strong>event_name</strong> ⇒ String </a>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
</span>
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<span class="note title readonly">readonly</span>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<span class="summary_desc"><div class='inline'>
|
|
245
|
+
<p>Event name in dot notation (e.g., ‘task.completed’).</p>
|
|
246
|
+
</div></span>
|
|
247
|
+
|
|
248
|
+
</li>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
<li class="public ">
|
|
252
|
+
<span class="summary_signature">
|
|
253
|
+
|
|
254
|
+
<a href="#metadata-instance_method" title="#metadata (instance method)">#<strong>metadata</strong> ⇒ Hash </a>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
</span>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
<span class="note title readonly">readonly</span>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
<span class="summary_desc"><div class='inline'>
|
|
274
|
+
<p>Additional configuration data.</p>
|
|
275
|
+
</div></span>
|
|
276
|
+
|
|
277
|
+
</li>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<li class="public ">
|
|
281
|
+
<span class="summary_signature">
|
|
282
|
+
|
|
283
|
+
<a href="#priority-instance_method" title="#priority (instance method)">#<strong>priority</strong> ⇒ Symbol </a>
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
</span>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
<span class="note title readonly">readonly</span>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
<span class="summary_desc"><div class='inline'>
|
|
303
|
+
<p>Priority level (:low, :normal, :high, :critical).</p>
|
|
304
|
+
</div></span>
|
|
305
|
+
|
|
306
|
+
</li>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
<li class="public ">
|
|
310
|
+
<span class="summary_signature">
|
|
311
|
+
|
|
312
|
+
<a href="#sampling_rate-instance_method" title="#sampling_rate (instance method)">#<strong>sampling_rate</strong> ⇒ Float </a>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
</span>
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
<span class="note title readonly">readonly</span>
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
<span class="summary_desc"><div class='inline'>
|
|
332
|
+
<p>Sampling rate (1.0 = 100%, 0.1 = 10%).</p>
|
|
333
|
+
</div></span>
|
|
334
|
+
|
|
335
|
+
</li>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
</ul>
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
<h2>
|
|
345
|
+
Instance Method Summary
|
|
346
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
347
|
+
</h2>
|
|
348
|
+
|
|
349
|
+
<ul class="summary">
|
|
350
|
+
|
|
351
|
+
<li class="public ">
|
|
352
|
+
<span class="summary_signature">
|
|
353
|
+
|
|
354
|
+
<a href="#active%3F-instance_method" title="#active? (instance method)">#<strong>active?</strong> ⇒ Boolean </a>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
</span>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<span class="summary_desc"><div class='inline'>
|
|
369
|
+
<p>Check if this mapping is active (enabled and should be sampled).</p>
|
|
370
|
+
</div></span>
|
|
371
|
+
|
|
372
|
+
</li>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<li class="public ">
|
|
376
|
+
<span class="summary_signature">
|
|
377
|
+
|
|
378
|
+
<a href="#description-instance_method" title="#description (instance method)">#<strong>description</strong> ⇒ String </a>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</span>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<span class="summary_desc"><div class='inline'>
|
|
393
|
+
<p>Get a description of this mapping for debugging.</p>
|
|
394
|
+
</div></span>
|
|
395
|
+
|
|
396
|
+
</li>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<li class="public ">
|
|
400
|
+
<span class="summary_signature">
|
|
401
|
+
|
|
402
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ EventMapping </a>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
</span>
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
<span class="note title constructor">constructor</span>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
<span class="summary_desc"><div class='inline'>
|
|
419
|
+
<p>Override initialize to ensure backends array is frozen.</p>
|
|
420
|
+
</div></span>
|
|
421
|
+
|
|
422
|
+
</li>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
<li class="public ">
|
|
426
|
+
<span class="summary_signature">
|
|
427
|
+
|
|
428
|
+
<a href="#routes_to_logs%3F-instance_method" title="#routes_to_logs? (instance method)">#<strong>routes_to_logs?</strong> ⇒ Boolean </a>
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
</span>
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
<span class="summary_desc"><div class='inline'>
|
|
443
|
+
<p>Check if this mapping routes to logs.</p>
|
|
444
|
+
</div></span>
|
|
445
|
+
|
|
446
|
+
</li>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
<li class="public ">
|
|
450
|
+
<span class="summary_signature">
|
|
451
|
+
|
|
452
|
+
<a href="#routes_to_metrics%3F-instance_method" title="#routes_to_metrics? (instance method)">#<strong>routes_to_metrics?</strong> ⇒ Boolean </a>
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
</span>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
<span class="summary_desc"><div class='inline'>
|
|
467
|
+
<p>Check if this mapping routes to metrics.</p>
|
|
468
|
+
</div></span>
|
|
469
|
+
|
|
470
|
+
</li>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
<li class="public ">
|
|
474
|
+
<span class="summary_signature">
|
|
475
|
+
|
|
476
|
+
<a href="#routes_to_traces%3F-instance_method" title="#routes_to_traces? (instance method)">#<strong>routes_to_traces?</strong> ⇒ Boolean </a>
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
</span>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
<span class="summary_desc"><div class='inline'>
|
|
491
|
+
<p>Check if this mapping routes to traces.</p>
|
|
492
|
+
</div></span>
|
|
493
|
+
|
|
494
|
+
</li>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
<li class="public ">
|
|
498
|
+
<span class="summary_signature">
|
|
499
|
+
|
|
500
|
+
<a href="#should_sample%3F-instance_method" title="#should_sample? (instance method)">#<strong>should_sample?</strong> ⇒ Boolean </a>
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
</span>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
<span class="summary_desc"><div class='inline'>
|
|
515
|
+
<p>Check if this event should be sampled.</p>
|
|
516
|
+
</div></span>
|
|
517
|
+
|
|
518
|
+
</li>
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
</ul>
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
<div id="constructor_details" class="method_details_list">
|
|
532
|
+
<h2>Constructor Details</h2>
|
|
533
|
+
|
|
534
|
+
<div class="method_details first">
|
|
535
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
536
|
+
|
|
537
|
+
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="Tasker::Telemetry::EventMapping (class)">EventMapping</a></span></tt>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
</h3><div class="docstring">
|
|
544
|
+
<div class="discussion">
|
|
545
|
+
|
|
546
|
+
<p>Override initialize to ensure backends array is frozen</p>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
</div>
|
|
550
|
+
</div>
|
|
551
|
+
<div class="tags">
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
</div><table class="source_code">
|
|
555
|
+
<tr>
|
|
556
|
+
<td>
|
|
557
|
+
<pre class="lines">
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
47
|
|
561
|
+
48
|
|
562
|
+
49
|
|
563
|
+
50
|
|
564
|
+
51</pre>
|
|
565
|
+
</td>
|
|
566
|
+
<td>
|
|
567
|
+
<pre class="code"><span class="info file"># File 'lib/tasker/telemetry/event_mapping.rb', line 47</span>
|
|
568
|
+
|
|
569
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>*</span><span class='rparen'>)</span>
|
|
570
|
+
<span class='kw'>super</span>
|
|
571
|
+
<span class='id identifier rubyid_backends'>backends</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
|
|
572
|
+
<span class='comment'># Don't freeze here - BaseConfig already freezes the object
|
|
573
|
+
</span><span class='kw'>end</span></pre>
|
|
574
|
+
</td>
|
|
575
|
+
</tr>
|
|
576
|
+
</table>
|
|
577
|
+
</div>
|
|
578
|
+
|
|
579
|
+
</div>
|
|
580
|
+
|
|
581
|
+
<div id="instance_attr_details" class="attr_details">
|
|
582
|
+
<h2>Instance Attribute Details</h2>
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
<span id=""></span>
|
|
586
|
+
<div class="method_details first">
|
|
587
|
+
<h3 class="signature first" id="backends-instance_method">
|
|
588
|
+
|
|
589
|
+
#<strong>backends</strong> ⇒ <tt>Array<Symbol></tt> <span class="extras">(readonly)</span>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
</h3><div class="docstring">
|
|
596
|
+
<div class="discussion">
|
|
597
|
+
|
|
598
|
+
<p>Returns List of backend types (:trace, :metrics, :logs).</p>
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
</div>
|
|
602
|
+
</div>
|
|
603
|
+
<div class="tags">
|
|
604
|
+
|
|
605
|
+
<p class="tag_title">Returns:</p>
|
|
606
|
+
<ul class="return">
|
|
607
|
+
|
|
608
|
+
<li>
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
<span class='type'>(<tt>Array<Symbol></tt>)</span>
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
—
|
|
616
|
+
<div class='inline'>
|
|
617
|
+
<p>List of backend types (:trace, :metrics, :logs)</p>
|
|
618
|
+
</div>
|
|
619
|
+
|
|
620
|
+
</li>
|
|
621
|
+
|
|
622
|
+
</ul>
|
|
623
|
+
|
|
624
|
+
</div><table class="source_code">
|
|
625
|
+
<tr>
|
|
626
|
+
<td>
|
|
627
|
+
<pre class="lines">
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
44</pre>
|
|
631
|
+
</td>
|
|
632
|
+
<td>
|
|
633
|
+
<pre class="code"><span class="info file"># File 'lib/tasker/telemetry/event_mapping.rb', line 44</span>
|
|
634
|
+
|
|
635
|
+
<span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:backends</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../../Tasker.html" title="Tasker (module)">Tasker</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Types.html" title="Tasker::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Array</span><span class='period'>.</span><span class='id identifier rubyid_of'>of</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Tasker.html" title="Tasker (module)">Tasker</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Types.html" title="Tasker::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Symbol</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:trace</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='rparen'>)</span></pre>
|
|
636
|
+
</td>
|
|
637
|
+
</tr>
|
|
638
|
+
</table>
|
|
639
|
+
</div>
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
<span id=""></span>
|
|
643
|
+
<div class="method_details ">
|
|
644
|
+
<h3 class="signature " id="enabled-instance_method">
|
|
645
|
+
|
|
646
|
+
#<strong>enabled</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
</h3><div class="docstring">
|
|
653
|
+
<div class="discussion">
|
|
654
|
+
|
|
655
|
+
<p>Returns True if this mapping should be processed.</p>
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
</div>
|
|
659
|
+
</div>
|
|
660
|
+
<div class="tags">
|
|
661
|
+
|
|
662
|
+
<p class="tag_title">Returns:</p>
|
|
663
|
+
<ul class="return">
|
|
664
|
+
|
|
665
|
+
<li>
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
—
|
|
673
|
+
<div class='inline'>
|
|
674
|
+
<p>True if this mapping should be processed</p>
|
|
675
|
+
</div>
|
|
676
|
+
|
|
677
|
+
</li>
|
|
678
|
+
|
|
679
|
+
</ul>
|
|
680
|
+
|
|
681
|
+
</div><table class="source_code">
|
|
682
|
+
<tr>
|
|
683
|
+
<td>
|
|
684
|
+
<pre class="lines">
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
57</pre>
|
|
688
|
+
</td>
|
|
689
|
+
<td>
|
|
690
|
+
<pre class="code"><span class="info file"># File 'lib/tasker/telemetry/event_mapping.rb', line 57</span>
|
|
691
|
+
|
|
692
|
+
<span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:enabled</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../../Tasker.html" title="Tasker (module)">Tasker</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Types.html" title="Tasker::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Bool</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span><span class='lparen'>(</span><span class='kw'>true</span><span class='rparen'>)</span></pre>
|
|
693
|
+
</td>
|
|
694
|
+
</tr>
|
|
695
|
+
</table>
|
|
696
|
+
</div>
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
<span id=""></span>
|
|
700
|
+
<div class="method_details ">
|
|
701
|
+
<h3 class="signature " id="event_name-instance_method">
|
|
702
|
+
|
|
703
|
+
#<strong>event_name</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
</h3><div class="docstring">
|
|
710
|
+
<div class="discussion">
|
|
711
|
+
|
|
712
|
+
<p>Returns Event name in dot notation (e.g., ‘task.completed’).</p>
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
</div>
|
|
716
|
+
</div>
|
|
717
|
+
<div class="tags">
|
|
718
|
+
|
|
719
|
+
<p class="tag_title">Returns:</p>
|
|
720
|
+
<ul class="return">
|
|
721
|
+
|
|
722
|
+
<li>
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
—
|
|
730
|
+
<div class='inline'>
|
|
731
|
+
<p>Event name in dot notation (e.g., ‘task.completed’)</p>
|
|
732
|
+
</div>
|
|
733
|
+
|
|
734
|
+
</li>
|
|
735
|
+
|
|
736
|
+
</ul>
|
|
737
|
+
|
|
738
|
+
</div><table class="source_code">
|
|
739
|
+
<tr>
|
|
740
|
+
<td>
|
|
741
|
+
<pre class="lines">
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
38</pre>
|
|
745
|
+
</td>
|
|
746
|
+
<td>
|
|
747
|
+
<pre class="code"><span class="info file"># File 'lib/tasker/telemetry/event_mapping.rb', line 38</span>
|
|
748
|
+
|
|
749
|
+
<span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:event_name</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../../Tasker.html" title="Tasker (module)">Tasker</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Types.html" title="Tasker::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>String</span></pre>
|
|
750
|
+
</td>
|
|
751
|
+
</tr>
|
|
752
|
+
</table>
|
|
753
|
+
</div>
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
<span id=""></span>
|
|
757
|
+
<div class="method_details ">
|
|
758
|
+
<h3 class="signature " id="metadata-instance_method">
|
|
759
|
+
|
|
760
|
+
#<strong>metadata</strong> ⇒ <tt>Hash</tt> <span class="extras">(readonly)</span>
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
</h3><div class="docstring">
|
|
767
|
+
<div class="discussion">
|
|
768
|
+
|
|
769
|
+
<p>Returns Additional configuration data.</p>
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
</div>
|
|
773
|
+
</div>
|
|
774
|
+
<div class="tags">
|
|
775
|
+
|
|
776
|
+
<p class="tag_title">Returns:</p>
|
|
777
|
+
<ul class="return">
|
|
778
|
+
|
|
779
|
+
<li>
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
—
|
|
787
|
+
<div class='inline'>
|
|
788
|
+
<p>Additional configuration data</p>
|
|
789
|
+
</div>
|
|
790
|
+
|
|
791
|
+
</li>
|
|
792
|
+
|
|
793
|
+
</ul>
|
|
794
|
+
|
|
795
|
+
</div><table class="source_code">
|
|
796
|
+
<tr>
|
|
797
|
+
<td>
|
|
798
|
+
<pre class="lines">
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
75</pre>
|
|
802
|
+
</td>
|
|
803
|
+
<td>
|
|
804
|
+
<pre class="code"><span class="info file"># File 'lib/tasker/telemetry/event_mapping.rb', line 75</span>
|
|
805
|
+
|
|
806
|
+
<span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:metadata</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../../Tasker.html" title="Tasker (module)">Tasker</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Types.html" title="Tasker::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Hash</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='rparen'>)</span></pre>
|
|
807
|
+
</td>
|
|
808
|
+
</tr>
|
|
809
|
+
</table>
|
|
810
|
+
</div>
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
<span id=""></span>
|
|
814
|
+
<div class="method_details ">
|
|
815
|
+
<h3 class="signature " id="priority-instance_method">
|
|
816
|
+
|
|
817
|
+
#<strong>priority</strong> ⇒ <tt>Symbol</tt> <span class="extras">(readonly)</span>
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
</h3><div class="docstring">
|
|
824
|
+
<div class="discussion">
|
|
825
|
+
|
|
826
|
+
<p>Returns Priority level (:low, :normal, :high, :critical).</p>
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
</div>
|
|
830
|
+
</div>
|
|
831
|
+
<div class="tags">
|
|
832
|
+
|
|
833
|
+
<p class="tag_title">Returns:</p>
|
|
834
|
+
<ul class="return">
|
|
835
|
+
|
|
836
|
+
<li>
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
—
|
|
844
|
+
<div class='inline'>
|
|
845
|
+
<p>Priority level (:low, :normal, :high, :critical)</p>
|
|
846
|
+
</div>
|
|
847
|
+
|
|
848
|
+
</li>
|
|
849
|
+
|
|
850
|
+
</ul>
|
|
851
|
+
|
|
852
|
+
</div><table class="source_code">
|
|
853
|
+
<tr>
|
|
854
|
+
<td>
|
|
855
|
+
<pre class="lines">
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
69</pre>
|
|
859
|
+
</td>
|
|
860
|
+
<td>
|
|
861
|
+
<pre class="code"><span class="info file"># File 'lib/tasker/telemetry/event_mapping.rb', line 69</span>
|
|
862
|
+
|
|
863
|
+
<span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:priority</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../../Tasker.html" title="Tasker (module)">Tasker</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Types.html" title="Tasker::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Symbol</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span><span class='lparen'>(</span><span class='symbol'>:normal</span><span class='rparen'>)</span></pre>
|
|
864
|
+
</td>
|
|
865
|
+
</tr>
|
|
866
|
+
</table>
|
|
867
|
+
</div>
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
<span id=""></span>
|
|
871
|
+
<div class="method_details ">
|
|
872
|
+
<h3 class="signature " id="sampling_rate-instance_method">
|
|
873
|
+
|
|
874
|
+
#<strong>sampling_rate</strong> ⇒ <tt>Float</tt> <span class="extras">(readonly)</span>
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
</h3><div class="docstring">
|
|
881
|
+
<div class="discussion">
|
|
882
|
+
|
|
883
|
+
<p>Returns Sampling rate (1.0 = 100%, 0.1 = 10%).</p>
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
</div>
|
|
887
|
+
</div>
|
|
888
|
+
<div class="tags">
|
|
889
|
+
|
|
890
|
+
<p class="tag_title">Returns:</p>
|
|
891
|
+
<ul class="return">
|
|
892
|
+
|
|
893
|
+
<li>
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
<span class='type'>(<tt>Float</tt>)</span>
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
—
|
|
901
|
+
<div class='inline'>
|
|
902
|
+
<p>Sampling rate (1.0 = 100%, 0.1 = 10%)</p>
|
|
903
|
+
</div>
|
|
904
|
+
|
|
905
|
+
</li>
|
|
906
|
+
|
|
907
|
+
</ul>
|
|
908
|
+
|
|
909
|
+
</div><table class="source_code">
|
|
910
|
+
<tr>
|
|
911
|
+
<td>
|
|
912
|
+
<pre class="lines">
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
63</pre>
|
|
916
|
+
</td>
|
|
917
|
+
<td>
|
|
918
|
+
<pre class="code"><span class="info file"># File 'lib/tasker/telemetry/event_mapping.rb', line 63</span>
|
|
919
|
+
|
|
920
|
+
<span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:sampling_rate</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../../Tasker.html" title="Tasker (module)">Tasker</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Types.html" title="Tasker::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Float</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span><span class='lparen'>(</span><span class='float'>1.0</span><span class='rparen'>)</span></pre>
|
|
921
|
+
</td>
|
|
922
|
+
</tr>
|
|
923
|
+
</table>
|
|
924
|
+
</div>
|
|
925
|
+
|
|
926
|
+
</div>
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
<div id="instance_method_details" class="method_details_list">
|
|
930
|
+
<h2>Instance Method Details</h2>
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
<div class="method_details first">
|
|
934
|
+
<h3 class="signature first" id="active?-instance_method">
|
|
935
|
+
|
|
936
|
+
#<strong>active?</strong> ⇒ <tt>Boolean</tt>
|
|
937
|
+
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
</h3><div class="docstring">
|
|
943
|
+
<div class="discussion">
|
|
944
|
+
|
|
945
|
+
<p>Check if this mapping is active (enabled and should be sampled)</p>
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
</div>
|
|
949
|
+
</div>
|
|
950
|
+
<div class="tags">
|
|
951
|
+
|
|
952
|
+
<p class="tag_title">Returns:</p>
|
|
953
|
+
<ul class="return">
|
|
954
|
+
|
|
955
|
+
<li>
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
—
|
|
963
|
+
<div class='inline'>
|
|
964
|
+
<p>True if this mapping should be processed</p>
|
|
965
|
+
</div>
|
|
966
|
+
|
|
967
|
+
</li>
|
|
968
|
+
|
|
969
|
+
</ul>
|
|
970
|
+
|
|
971
|
+
</div><table class="source_code">
|
|
972
|
+
<tr>
|
|
973
|
+
<td>
|
|
974
|
+
<pre class="lines">
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
114
|
|
978
|
+
115
|
|
979
|
+
116</pre>
|
|
980
|
+
</td>
|
|
981
|
+
<td>
|
|
982
|
+
<pre class="code"><span class="info file"># File 'lib/tasker/telemetry/event_mapping.rb', line 114</span>
|
|
983
|
+
|
|
984
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_active?'>active?</span>
|
|
985
|
+
<span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>&&</span> <span class='id identifier rubyid_should_sample?'>should_sample?</span>
|
|
986
|
+
<span class='kw'>end</span></pre>
|
|
987
|
+
</td>
|
|
988
|
+
</tr>
|
|
989
|
+
</table>
|
|
990
|
+
</div>
|
|
991
|
+
|
|
992
|
+
<div class="method_details ">
|
|
993
|
+
<h3 class="signature " id="description-instance_method">
|
|
994
|
+
|
|
995
|
+
#<strong>description</strong> ⇒ <tt>String</tt>
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
</h3><div class="docstring">
|
|
1002
|
+
<div class="discussion">
|
|
1003
|
+
|
|
1004
|
+
<p>Get a description of this mapping for debugging</p>
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
</div>
|
|
1008
|
+
</div>
|
|
1009
|
+
<div class="tags">
|
|
1010
|
+
|
|
1011
|
+
<p class="tag_title">Returns:</p>
|
|
1012
|
+
<ul class="return">
|
|
1013
|
+
|
|
1014
|
+
<li>
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
—
|
|
1022
|
+
<div class='inline'>
|
|
1023
|
+
<p>Human-readable description</p>
|
|
1024
|
+
</div>
|
|
1025
|
+
|
|
1026
|
+
</li>
|
|
1027
|
+
|
|
1028
|
+
</ul>
|
|
1029
|
+
|
|
1030
|
+
</div><table class="source_code">
|
|
1031
|
+
<tr>
|
|
1032
|
+
<td>
|
|
1033
|
+
<pre class="lines">
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
121
|
|
1037
|
+
122
|
|
1038
|
+
123</pre>
|
|
1039
|
+
</td>
|
|
1040
|
+
<td>
|
|
1041
|
+
<pre class="code"><span class="info file"># File 'lib/tasker/telemetry/event_mapping.rb', line 121</span>
|
|
1042
|
+
|
|
1043
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
|
|
1044
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_event_name'>event_name</span><span class='embexpr_end'>}</span><span class='tstring_content'> → </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_backends'>backends</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>, </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'> (</span><span class='embexpr_beg'>#{</span><span class='lparen'>(</span><span class='id identifier rubyid_sampling_rate'>sampling_rate</span> <span class='op'>*</span> <span class='int'>100</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_round'>round</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>% sampled)</span><span class='tstring_end'>"</span></span>
|
|
1045
|
+
<span class='kw'>end</span></pre>
|
|
1046
|
+
</td>
|
|
1047
|
+
</tr>
|
|
1048
|
+
</table>
|
|
1049
|
+
</div>
|
|
1050
|
+
|
|
1051
|
+
<div class="method_details ">
|
|
1052
|
+
<h3 class="signature " id="routes_to_logs?-instance_method">
|
|
1053
|
+
|
|
1054
|
+
#<strong>routes_to_logs?</strong> ⇒ <tt>Boolean</tt>
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
</h3><div class="docstring">
|
|
1061
|
+
<div class="discussion">
|
|
1062
|
+
|
|
1063
|
+
<p>Check if this mapping routes to logs</p>
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
</div>
|
|
1067
|
+
</div>
|
|
1068
|
+
<div class="tags">
|
|
1069
|
+
|
|
1070
|
+
<p class="tag_title">Returns:</p>
|
|
1071
|
+
<ul class="return">
|
|
1072
|
+
|
|
1073
|
+
<li>
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
—
|
|
1081
|
+
<div class='inline'>
|
|
1082
|
+
<p>True if backends includes :logs</p>
|
|
1083
|
+
</div>
|
|
1084
|
+
|
|
1085
|
+
</li>
|
|
1086
|
+
|
|
1087
|
+
</ul>
|
|
1088
|
+
|
|
1089
|
+
</div><table class="source_code">
|
|
1090
|
+
<tr>
|
|
1091
|
+
<td>
|
|
1092
|
+
<pre class="lines">
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
94
|
|
1096
|
+
95
|
|
1097
|
+
96</pre>
|
|
1098
|
+
</td>
|
|
1099
|
+
<td>
|
|
1100
|
+
<pre class="code"><span class="info file"># File 'lib/tasker/telemetry/event_mapping.rb', line 94</span>
|
|
1101
|
+
|
|
1102
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_routes_to_logs?'>routes_to_logs?</span>
|
|
1103
|
+
<span class='id identifier rubyid_backends'>backends</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='symbol'>:logs</span><span class='rparen'>)</span>
|
|
1104
|
+
<span class='kw'>end</span></pre>
|
|
1105
|
+
</td>
|
|
1106
|
+
</tr>
|
|
1107
|
+
</table>
|
|
1108
|
+
</div>
|
|
1109
|
+
|
|
1110
|
+
<div class="method_details ">
|
|
1111
|
+
<h3 class="signature " id="routes_to_metrics?-instance_method">
|
|
1112
|
+
|
|
1113
|
+
#<strong>routes_to_metrics?</strong> ⇒ <tt>Boolean</tt>
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
</h3><div class="docstring">
|
|
1120
|
+
<div class="discussion">
|
|
1121
|
+
|
|
1122
|
+
<p>Check if this mapping routes to metrics</p>
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
</div>
|
|
1126
|
+
</div>
|
|
1127
|
+
<div class="tags">
|
|
1128
|
+
|
|
1129
|
+
<p class="tag_title">Returns:</p>
|
|
1130
|
+
<ul class="return">
|
|
1131
|
+
|
|
1132
|
+
<li>
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
—
|
|
1140
|
+
<div class='inline'>
|
|
1141
|
+
<p>True if backends includes :metrics</p>
|
|
1142
|
+
</div>
|
|
1143
|
+
|
|
1144
|
+
</li>
|
|
1145
|
+
|
|
1146
|
+
</ul>
|
|
1147
|
+
|
|
1148
|
+
</div><table class="source_code">
|
|
1149
|
+
<tr>
|
|
1150
|
+
<td>
|
|
1151
|
+
<pre class="lines">
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
87
|
|
1155
|
+
88
|
|
1156
|
+
89</pre>
|
|
1157
|
+
</td>
|
|
1158
|
+
<td>
|
|
1159
|
+
<pre class="code"><span class="info file"># File 'lib/tasker/telemetry/event_mapping.rb', line 87</span>
|
|
1160
|
+
|
|
1161
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_routes_to_metrics?'>routes_to_metrics?</span>
|
|
1162
|
+
<span class='id identifier rubyid_backends'>backends</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='symbol'>:metrics</span><span class='rparen'>)</span>
|
|
1163
|
+
<span class='kw'>end</span></pre>
|
|
1164
|
+
</td>
|
|
1165
|
+
</tr>
|
|
1166
|
+
</table>
|
|
1167
|
+
</div>
|
|
1168
|
+
|
|
1169
|
+
<div class="method_details ">
|
|
1170
|
+
<h3 class="signature " id="routes_to_traces?-instance_method">
|
|
1171
|
+
|
|
1172
|
+
#<strong>routes_to_traces?</strong> ⇒ <tt>Boolean</tt>
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
</h3><div class="docstring">
|
|
1179
|
+
<div class="discussion">
|
|
1180
|
+
|
|
1181
|
+
<p>Check if this mapping routes to traces</p>
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
</div>
|
|
1185
|
+
</div>
|
|
1186
|
+
<div class="tags">
|
|
1187
|
+
|
|
1188
|
+
<p class="tag_title">Returns:</p>
|
|
1189
|
+
<ul class="return">
|
|
1190
|
+
|
|
1191
|
+
<li>
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
—
|
|
1199
|
+
<div class='inline'>
|
|
1200
|
+
<p>True if backends includes :trace</p>
|
|
1201
|
+
</div>
|
|
1202
|
+
|
|
1203
|
+
</li>
|
|
1204
|
+
|
|
1205
|
+
</ul>
|
|
1206
|
+
|
|
1207
|
+
</div><table class="source_code">
|
|
1208
|
+
<tr>
|
|
1209
|
+
<td>
|
|
1210
|
+
<pre class="lines">
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
80
|
|
1214
|
+
81
|
|
1215
|
+
82</pre>
|
|
1216
|
+
</td>
|
|
1217
|
+
<td>
|
|
1218
|
+
<pre class="code"><span class="info file"># File 'lib/tasker/telemetry/event_mapping.rb', line 80</span>
|
|
1219
|
+
|
|
1220
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_routes_to_traces?'>routes_to_traces?</span>
|
|
1221
|
+
<span class='id identifier rubyid_backends'>backends</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='symbol'>:trace</span><span class='rparen'>)</span>
|
|
1222
|
+
<span class='kw'>end</span></pre>
|
|
1223
|
+
</td>
|
|
1224
|
+
</tr>
|
|
1225
|
+
</table>
|
|
1226
|
+
</div>
|
|
1227
|
+
|
|
1228
|
+
<div class="method_details ">
|
|
1229
|
+
<h3 class="signature " id="should_sample?-instance_method">
|
|
1230
|
+
|
|
1231
|
+
#<strong>should_sample?</strong> ⇒ <tt>Boolean</tt>
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
</h3><div class="docstring">
|
|
1238
|
+
<div class="discussion">
|
|
1239
|
+
|
|
1240
|
+
<p>Check if this event should be sampled</p>
|
|
1241
|
+
|
|
1242
|
+
<p>Uses a simple random sampling approach. For production, you might want to implement more sophisticated sampling strategies.</p>
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
</div>
|
|
1246
|
+
</div>
|
|
1247
|
+
<div class="tags">
|
|
1248
|
+
|
|
1249
|
+
<p class="tag_title">Returns:</p>
|
|
1250
|
+
<ul class="return">
|
|
1251
|
+
|
|
1252
|
+
<li>
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
—
|
|
1260
|
+
<div class='inline'>
|
|
1261
|
+
<p>True if this event should be processed</p>
|
|
1262
|
+
</div>
|
|
1263
|
+
|
|
1264
|
+
</li>
|
|
1265
|
+
|
|
1266
|
+
</ul>
|
|
1267
|
+
|
|
1268
|
+
</div><table class="source_code">
|
|
1269
|
+
<tr>
|
|
1270
|
+
<td>
|
|
1271
|
+
<pre class="lines">
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
104
|
|
1275
|
+
105
|
|
1276
|
+
106
|
|
1277
|
+
107
|
|
1278
|
+
108
|
|
1279
|
+
109</pre>
|
|
1280
|
+
</td>
|
|
1281
|
+
<td>
|
|
1282
|
+
<pre class="code"><span class="info file"># File 'lib/tasker/telemetry/event_mapping.rb', line 104</span>
|
|
1283
|
+
|
|
1284
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_should_sample?'>should_sample?</span>
|
|
1285
|
+
<span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span> <span class='op'>>=</span> <span class='float'>1.0</span>
|
|
1286
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span> <span class='op'><=</span> <span class='float'>0.0</span>
|
|
1287
|
+
|
|
1288
|
+
<span class='const'>Random</span><span class='period'>.</span><span class='id identifier rubyid_rand'>rand</span> <span class='op'><=</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span>
|
|
1289
|
+
<span class='kw'>end</span></pre>
|
|
1290
|
+
</td>
|
|
1291
|
+
</tr>
|
|
1292
|
+
</table>
|
|
1293
|
+
</div>
|
|
1294
|
+
|
|
1295
|
+
</div>
|
|
1296
|
+
|
|
1297
|
+
</div>
|
|
1298
|
+
|
|
1299
|
+
<div id="footer">
|
|
1300
|
+
Generated on Tue Jul 1 16:47:38 2025 by
|
|
1301
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1302
|
+
0.9.37 (ruby-3.2.4).
|
|
1303
|
+
</div>
|
|
1304
|
+
|
|
1305
|
+
</div>
|
|
1306
|
+
</body>
|
|
1307
|
+
</html>
|