skywalking/agent/protocol/__init__.py

#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

from abc import ABC, abstractmethod
from queue import Queue
from asyncio import Queue as QueueAsync


class Protocol(ABC):
    def is_ready(self) -> bool:
        """
        Whether the reporter may send RPCs this tick.
        gRPC overrides with channel READY gate; HTTP/Kafka stay always-ready.
        """
        return True

    @abstractmethod
    def heartbeat(self):
        raise NotImplementedError()

    @abstractmethod
    def report_segment(self, queue: Queue, block: bool = True):
        raise NotImplementedError()

    @abstractmethod
    def report_log(self, queue: Queue, block: bool = True):
        raise NotImplementedError()

    @abstractmethod
    def report_meter(self, queue: Queue, block: bool = True):
        raise NotImplementedError()

    @abstractmethod
    def report_snapshot(self, queue: Queue, block: bool = True):
        raise NotImplementedError()

    @abstractmethod
    def query_profile_commands(self):
        raise NotImplementedError()

    @abstractmethod
    def notify_profile_task_finish(self, task):
        raise NotImplementedError()


class ProtocolAsync(ABC):
    def is_ready(self) -> bool:
        """See Protocol.is_ready — gRPC aio overrides with channel READY gate."""
        return True

    @abstractmethod
    async def heartbeat(self):
        raise NotImplementedError()

    @abstractmethod
    async def report_segment(self, queue: QueueAsync):
        raise NotImplementedError()

    @abstractmethod
    async def report_log(self, queue: QueueAsync):
        raise NotImplementedError()

    @abstractmethod
    async def report_meter(self, queue: QueueAsync):
        raise NotImplementedError()

    @abstractmethod
    async def report_snapshot(self, queue: QueueAsync):
        raise NotImplementedError()

    @abstractmethod
    async def query_profile_commands(self):
        raise NotImplementedError()

    @abstractmethod
    async def notify_profile_task_finish(self, task):
        raise NotImplementedError()