quay/buildman/builder.py

import logging
import logging.config
import os
import socket
import time

import sentry_sdk
from sentry_sdk.integrations.flask import FlaskIntegration
from sentry_sdk.integrations.logging import LoggingIntegration
from sentry_sdk.integrations.sqlalchemy import SqlalchemyIntegration
from sentry_sdk.integrations.stdlib import StdlibIntegration

import features
from app import (
    OVERRIDE_CONFIG_DIRECTORY,
    app,
    build_logs,
    dockerfile_build_queue,
    instance_keys,
)
from app import userfiles as user_files
from buildman.manager.ephemeral import EphemeralBuilderManager
from buildman.server import BuilderServer
from util.log import logfile_path
from util.saas.exceptionlog import _sentry_before_send_ignore_known

logger = logging.getLogger(__name__)

BUILD_MANAGERS = {
    "ephemeral": EphemeralBuilderManager,
}

EXTERNALLY_MANAGED = "external"

DEFAULT_CONTROLLER_PORT = 8686


def initialize_sentry():
    """Initialize Sentry if configured."""
    # Define buildman name for general use
    buildman_name = "%s:buildman" % socket.gethostname()

    if app.config.get("EXCEPTION_LOG_TYPE", "FakeSentry") == "Sentry":
        sentry_dsn = app.config.get("SENTRY_DSN", "")
        if sentry_dsn:
            try:
                integrations = []

                # Always include logging integration
                integrations.append(
                    LoggingIntegration(level=logging.INFO, event_level=logging.ERROR)
                )

                # Only add Flask and SQLAlchemy integrations if OpenTelemetry is not enabled
                if not getattr(features, "OTEL_TRACING", False):
                    integrations.extend(
                        [
                            FlaskIntegration(transaction_style="endpoint"),
                            SqlalchemyIntegration(),
                            StdlibIntegration(),
                        ]
                    )
                else:
                    logger.info(
                        "OpenTelemetry enabled - using minimal Sentry integrations for buildman"
                    )

                sentry_sdk.init(
                    dsn=sentry_dsn,
                    environment=app.config.get("SENTRY_ENVIRONMENT", "production"),
                    traces_sample_rate=app.config.get("SENTRY_TRACES_SAMPLE_RATE", 0.1),
                    profiles_sample_rate=app.config.get("SENTRY_PROFILES_SAMPLE_RATE", 0.1),
                    sample_rate=app.config.get("SENTRY_SAMPLE_RATE", 0.1),
                    integrations=integrations,
                    default_integrations=False,
                    auto_session_tracking=True,
                    before_send=_sentry_before_send_ignore_known,
                )
                sentry_sdk.set_tag("service", "buildman")
                sentry_sdk.set_tag("buildman", buildman_name)
            except Exception as e:
                logger.warning("Failed to initialize Sentry: %s", str(e))


def run_build_manager():
    if app.config.get("ACCOUNT_RECOVERY_MODE", False):
        logger.debug("Quay running in account recovery mode")
        while True:
            time.sleep(100000)

    if not features.BUILD_SUPPORT:
        logger.debug("Building is disabled. Please enable the feature flag")
        while True:
            time.sleep(1000)

    if app.config.get("REGISTRY_STATE", "normal") == "readonly":
        logger.debug("Building is disabled while in read-only mode.")
        while True:
            time.sleep(1000)

    build_manager_config = app.config.get("BUILD_MANAGER")
    if build_manager_config is None:
        return

    # If the build system is externally managed, then we just sleep this process.
    if build_manager_config[0] == EXTERNALLY_MANAGED:
        logger.debug("Builds are externally managed.")
        while True:
            time.sleep(1000)
        return

    logger.debug('Asking to start build manager with lifecycle "%s"', build_manager_config[0])
    manager_klass = BUILD_MANAGERS.get(build_manager_config[0])
    if manager_klass is None:
        return

    manager_hostname = os.environ.get(
        "BUILDMAN_HOSTNAME", app.config.get("BUILDMAN_HOSTNAME", app.config["SERVER_HOSTNAME"])
    )
    controller_port = int(
        os.environ.get(
            "BUILDMAN_CONTROLLER_PORT",
            app.config.get("BUILDMAN_CONTROLLER_PORT", DEFAULT_CONTROLLER_PORT),
        )
    )

    logger.debug(
        "Will pass buildman hostname %s to builders for websocket connection", manager_hostname
    )

    logger.debug('Starting build manager with lifecycle "%s"', build_manager_config[0])

    server = BuilderServer(
        app.config["SERVER_HOSTNAME"],
        manager_hostname,
        dockerfile_build_queue,
        build_logs,
        user_files,
        manager_klass,
        build_manager_config[1],
        instance_keys,
    )
    server.run("0.0.0.0", controller_port)


if __name__ == "__main__":
    logging.config.fileConfig(logfile_path(debug=False), disable_existing_loggers=False)
    logging.getLogger("peewee").setLevel(logging.WARN)
    logging.getLogger("boto").setLevel(logging.WARN)

    initialize_sentry()

    run_build_manager()