Skip to content

Do not report aws_log_type tag if missing from destination config #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bgaudin-lc merged 1 commit into from
Oct 15, 2025
Merged

Do not report aws_log_type tag if missing from destination config #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions log_forwarder/data_retriever.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class DataRetriever:
def get_name(self):
raise NotImplementedError()

def get_collection_type(self):
def get_source_type(self):
raise NotImplementedError()

def get_data(self):
Expand All @@ -37,7 +37,7 @@ def __init__(self, config: Config, bucket_name, s3_key):
self.s3_client = S3Client(config.filepath)
logger.debug('type=%s, bucket=%s, s3_key=%s', self.__class__, self.src_bucket_name, self.src_key)

def get_collection_type(self):
def get_source_type(self):
return 's3'

def get_name(self):
Expand Down Expand Up @@ -122,7 +122,7 @@ class CloudwatchDataRetriever(DataRetriever):
def get_name(self):
return 'Cloudwatch'

def get_collection_type(self):
def get_source_type(self):
return 'cloudwatch'

def __init__(self, config: Config):
Expand Down
19 changes: 7 additions & 12 deletions log_forwarder/destination_provider.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
from data_retriever import DataRetriever
from config import DestinationConfig, CLOUDWATCH_LOG_TYPE
from exceptions import LogTypeMissingException


class DestinationProvider:
Expand All @@ -9,33 +8,29 @@ def __init__(self, dest_config: DestinationConfig, data_retriever: DataRetriever
self._config: DestinationConfig = dest_config
self._data_retriever: DataRetriever = data_retriever

def get_type(self, data_id):
if (self._config.destination_config is not None and data_id in self._config.get_keys() and
self._config.get_log_type(data_id) is not None):
return self._config.get_log_type(data_id)
if self._data_retriever.get_collection_type() == 'cloudwatch':
def get_log_type(self, data_id):
if self._data_retriever.get_source_type() == 'cloudwatch':
return CLOUDWATCH_LOG_TYPE
raise LogTypeMissingException('Log type required in configuration. data_type=%s, data_id=%s',
self._data_retriever.get_collection_type(), data_id)
return self._config.get_log_type(data_id)

def get_dataset(self, data_id):
if (self._config.destination_config is not None and data_id in self._config.get_keys() and
self._config.get_dataset(data_id) is not None):
return self._config.get_dataset(data_id)
if self._data_retriever.get_collection_type() == 'cloudwatch':
if self._data_retriever.get_source_type() == 'cloudwatch':
return data_id
return None

def get_collection(self, data_id):
if (self._config.destination_config is not None and data_id in self._config.get_keys() and
self._config.get_collection(data_id) is not None):
return self._config.get_collection(data_id)
if self._data_retriever.get_collection_type() == 'cloudwatch':
if self._data_retriever.get_source_type() == 'cloudwatch':
return self._config.get_cloudwatch_default_collection()
return None

def get_dataset_tags(self, data_id):
log_type = self.get_type(data_id)
tags = {'aws_log_type': log_type if log_type is not None else 'unknown'}
log_type = self.get_log_type(data_id)
tags = {'aws_log_type': log_type} if log_type is not None else {}
tags.update(self._config.get_dataset_tags(data_id))
return tags
2 changes: 0 additions & 2 deletions log_forwarder/exceptions.py
View file
Open in desktop

This file was deleted.

15 changes: 6 additions & 9 deletions tests/test_destination_provider.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import json
import base64
import tempfile
from exceptions import LogTypeMissingException

from config import DestinationConfig, Config, CLOUDWATCH_LOG_TYPE
from data_retriever import CloudwatchDataRetriever, DataRetriever, S3DataRetriever, CustomS3Retriever, \
DataRetrieverFactory, logger
from data_retriever import (CloudwatchDataRetriever, DataRetriever, S3DataRetriever, CustomS3Retriever,
DataRetrieverFactory)
from destination_provider import DestinationProvider

import pytest
Expand All @@ -14,7 +13,7 @@ def _get_data(data_retriever, log_group_name):
data_retriever.log_group_name = log_group_name


def test_s3_requires_log_type_in_config():
def test_s3_no_log_type_in_config():
bucket_name = 'my_bucket'
s3_key = 'my_key'
with tempfile.NamedTemporaryFile() as f:
Expand All @@ -23,8 +22,7 @@ def test_s3_requires_log_type_in_config():
dest_config = DestinationConfig()
data_retriever = S3DataRetriever(config, bucket_name, s3_key)
destination_provider = DestinationProvider(dest_config, data_retriever)
with pytest.raises(LogTypeMissingException) as _:
destination_provider.get_type(data_id)
assert destination_provider.get_log_type(data_id) is None


def test_s3_custom_path():
Expand All @@ -49,10 +47,10 @@ def test_cloudwatch_no_config(monkeypatch):
data_retriever = CloudwatchDataRetriever(config)
monkeypatch.setattr(DataRetriever, 'get_data', lambda: _get_data(data_retriever, log_group_name))
destination_provider = DestinationProvider(dest_config, data_retriever)
assert destination_provider.get_type(log_group_name) == CLOUDWATCH_LOG_TYPE
assert destination_provider.get_dataset(log_group_name) == log_group_name
assert destination_provider.get_collection(log_group_name) is None
assert destination_provider.get_dataset_tags(log_group_name) == {'aws_log_type': 'cloudwatch_log'}
assert destination_provider.get_log_type(log_group_name) == CLOUDWATCH_LOG_TYPE
assert destination_provider.get_dataset_tags(log_group_name) == {'aws_log_type': CLOUDWATCH_LOG_TYPE}


def test_cloudwatch_default_collection(monkeypatch):
Expand Down Expand Up @@ -80,7 +78,6 @@ def test_cloudwatch_config_takes_precedence(monkeypatch):
# mock _get_data in order to associate log group name to the data retriever
monkeypatch.setattr(DataRetriever, 'get_data', lambda: _get_data(data_retriever, log_group_name_from_config))
destination_provider = DestinationProvider(dest_config, data_retriever)
assert destination_provider.get_type(log_group_name) == CLOUDWATCH_LOG_TYPE
assert destination_provider.get_dataset(log_group_name) == log_group_name_from_config
assert destination_provider.get_collection(log_group_name) == log_set_from_config

Expand Down