Skip to content
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.

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

splunkPlatform.fieldNameConvention.renameFieldsSck doesn't cover journald units or extraFileLogs #682

Closed
vinzent opened this issue Mar 3, 2023 · 3 comments · Fixed by #837
Labels
enhancement New feature or request Splunk Platform Issue related to Splunk Platform destination

Comments

@vinzent
Copy link
Contributor

vinzent commented Mar 3, 2023

According to the SCK migration guide, it's possible to preserve the Splunk field names as used with SCK. Without this, we would need to rework all our custom Splunk Dashboards.

If you wish to continue using Splunk Connect for Kubernetes's naming convention, you can use the following configuration:
```yaml
splunkPlatform:
fieldNameConvention:
# Boolean for renaming pod metadata fields to match to Splunk Connect for Kubernetes helm chart.
renameFieldsSck: true
# Boolean for keeping Otel convention fields after renaming it
keepOtelConvention: false
```

Now I discovered that the setting only affects the logs pipeline but not the logs/host. The resource/logs is not included in the logs/host pipeline.

Probably for journald and extraFileLogs only the cluster_name field is relevant.

- key: cluster_name
from_attribute: k8s.cluster.name
action: upsert

@matthewmodestino
Copy link

matthewmodestino commented Mar 6, 2023

I don't believe SCK really set any major fields for those sources...do you have examples of said fields?
Most of them would have been custom or from fluentd specific input implementations, and can likely be set in otel inputs anyways...

Also while i understand it makes cutting over easy, SCK wasn't exactly thinking long term about fields and formats, whereas OTel formats will be with us for the foreseeable future and beyond. In many cases it also has much better fields/info. so I'd caution staying married to anything SCK for the long term anyways....

would be interested to see what fields you are talking about as the sck config doesnt exactly do anything special with those sources that you can't do today in otel configs.

@vinzent
Copy link
Contributor Author

vinzent commented Mar 6, 2023

I think only cluster_name is missing for extraLogsFiles. At least this is a field i'm using in dashboards for openshift audit logs to disinct the different clusters. Haven't checked if k8s.cluster.name is available.

I personally don't mind if SCK fields go away. Problem is once we upgrade and don't have SCK fields available, any splunk dashboard built by appdevs will immediately stop working. I think we need to give them some time to transition to the new fields. They need to exist so they can "see them" and adjust their config.

@matthewmodestino
Copy link

Ah yes, will check the pipeline that gets made for extraFilelogs, I was playing with this backward compatibility feature recently. Worst case I should be able to see what needs to be added to the filelog and journald pipeline to add it.

@atoulme atoulme added Splunk Platform Issue related to Splunk Platform destination enhancement New feature or request labels Apr 5, 2023
vinzent added a commit to vinzent/splunk-otel-collector-chart that referenced this issue Jun 28, 2023
Up to now the cluster_name field was only set in `resource/logs`. This
snippet was only included for the container logs, but not for host logs
(files, journald).

This change moves the cluster_name field to the `resource` snippet,
which is according inline comment used for all things that pass through
otel.

Fixes signalfx#682
vinzent added a commit to vinzent/splunk-otel-collector-chart that referenced this issue Jun 28, 2023
Up to now the cluster_name field was only set in `resource/logs`. This
snippet was only included for the container logs, but not for host logs
(files, journald).

This change moves the cluster_name field to the `resource` snippet,
which is according inline comment used for all things that pass through
otel.

Fixes signalfx#682
vinzent added a commit to vinzent/splunk-otel-collector-chart that referenced this issue Jun 29, 2023
Up to now the cluster_name field was only set in `resource/logs`. This
snippet was only included for the container logs, but not for host logs
(files, journald).

This change moves the cluster_name field to the `resource` snippet,
which is according inline comment used for all things that pass through
otel.

Fixes signalfx#682
dmitryax pushed a commit that referenced this issue Jun 29, 2023
Up to now the cluster_name field was only set in `resource/logs`. This
snippet was only included for the container logs, but not for host logs
(files, journald).

This change moves the cluster_name field to the `resource` snippet,
which is according inline comment used for all things that pass through
otel.

Fixes #682
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Splunk Platform Issue related to Splunk Platform destination
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants