File: //usr/local/share/elastic_apm/v1.9.1/ElasticApm/Impl/Log/Backend.php
<?php
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. 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.
*/
declare(strict_types=1);
namespace Elastic\Apm\Impl\Log;
use Elastic\Apm\Impl\Util\ClassNameUtil;
use Elastic\Apm\Impl\Util\DbgUtil;
use Elastic\Apm\Impl\Util\ElasticApmExtensionUtil;
/**
* Code in this file is part of implementation internals and thus it is not covered by the backward compatibility.
*
* @internal
*/
final class Backend implements LoggableInterface
{
public const NAMESPACE_KEY = 'namespace';
public const CLASS_KEY = 'class';
/** @var int */
private $maxEnabledLevel;
/** @var SinkInterface */
private $logSink;
public function __construct(int $maxEnabledLevel, ?SinkInterface $logSink)
{
$this->maxEnabledLevel = $maxEnabledLevel;
$this->logSink = $logSink ??
(ElasticApmExtensionUtil::isLoaded()
? new SinkToCExt()
: NoopLogSink::singletonInstance());
}
public function isEnabledForLevel(int $level): bool
{
return $this->maxEnabledLevel >= $level;
}
public function clone(): self
{
return new self($this->maxEnabledLevel, $this->logSink);
}
public function setMaxEnabledLevel(int $maxEnabledLevel): void
{
$this->maxEnabledLevel = $maxEnabledLevel;
}
/**
* @param array<string, mixed> $statementCtx
* @param LoggerData $loggerData
*
* @return array<array<string, mixed>>
*/
private static function buildContextsStack(array $statementCtx, LoggerData $loggerData): array
{
$result = [];
for (
$currentLoggerData = $loggerData;
$currentLoggerData !== null;
$currentLoggerData = $currentLoggerData->inheritedData
) {
$result[] = $currentLoggerData->context;
}
$result[] = [
self::NAMESPACE_KEY => $loggerData->namespace,
self::CLASS_KEY => ClassNameUtil::fqToShort($loggerData->fqClassName),
];
$result[] = $statementCtx;
return $result;
}
/**
* @param int $statementLevel
* @param string $message
* @param array<string, mixed> $statementCtx
* @param int $srcCodeLine
* @param string $srcCodeFunc
* @param LoggerData $loggerData
* @param bool|null $includeStacktrace
* @param int $numberOfStackFramesToSkip
*
* @phpstan-param 0|positive-int $numberOfStackFramesToSkip
*/
public function log(
int $statementLevel,
string $message,
array $statementCtx,
int $srcCodeLine,
string $srcCodeFunc,
LoggerData $loggerData,
?bool $includeStacktrace,
int $numberOfStackFramesToSkip
): void {
$this->logSink->consume(
$statementLevel,
$message,
self::buildContextsStack($statementCtx, $loggerData),
$loggerData->category,
$loggerData->srcCodeFile,
$srcCodeLine,
$srcCodeFunc,
$includeStacktrace,
$numberOfStackFramesToSkip + 1
);
}
/** @noinspection PhpUnused */
public function getSink(): SinkInterface
{
return $this->logSink;
}
public function toLog(LogStreamInterface $stream): void
{
$stream->toLogAs(['maxEnabledLevel' => Level::intToName($this->maxEnabledLevel), 'logSink' => DbgUtil::getType($this->logSink)]);
}
}