Design review to allow underscore in event name #2232

sagarvish1989 · 2024-10-21T22:54:30Z

Fixes #
Design discussion issue #

Changes

Please provide a brief description of the changes here.

Merge requirement checklist

CONTRIBUTING guidelines followed (license requirements, nullable enabled, static analysis, etc.)
Unit tests added/updated
Appropriate CHANGELOG.md files updated for non-trivial changes
Changes in public API reviewed (if applicable)

linux-foundation-easycla · 2024-10-21T22:54:33Z

✅ login: CodeBlanch / name: Mikel Blanchard (444b078, 316c6b7, 9e2f04a)
❌ The email address for the commit (7d816f4) is not linked to the GitHub account, preventing the EasyCLA check. Consult this Help Article and GitHub Help to resolve. (To view the commit's email address, add .patch at the end of this PR page's URL.) For further assistance with EasyCLA, please submit a support request ticket.

gesiu · 2024-10-21T23:10:53Z

src/OpenTelemetry.Exporter.OneCollector/Internal/EventNameManager.cs

@@ -54,7 +65,8 @@ public static bool IsEventNameValid(string eventName)

    public ResolvedEventFullName ResolveEventFullName(
        string? eventNamespace,
-        string? eventName)
+        string? eventName,
+        EventNameDelimiter eventNameDelimiter = EventNameDelimiter.Period)


Does this do anything?

Yeah, not needed. Will remove.

gesiu · 2024-10-21T23:11:23Z

src/OpenTelemetry.Exporter.OneCollector/Internal/EventNameManager.cs

@@ -124,7 +136,8 @@ private static byte[] BuildEventFullName(string eventNamespace, string eventName
        {
            WriteEventFullNameComponent(eventNamespace, destination, ref cursor);

-            destination[cursor++] = (byte)'.';
+            byte delimiter = eventNameDelimiter == EventNameDelimiter.Period ? (byte)'.' : (byte)'_';


This should use a lookup table

gesiu · 2024-10-21T23:13:47Z

src/OpenTelemetry.Exporter.OneCollector/Internal/EventNameManager.cs

@@ -112,7 +124,7 @@ public ResolvedEventFullName ResolveEventFullName(
        return resolvedEventFullName;
    }

-    private static byte[] BuildEventFullName(string eventNamespace, string eventName)
+    private static byte[] BuildEventFullName(string eventNamespace, string eventName, EventNameDelimiter eventNameDelimiter = EventNameDelimiter.Period)


Probably by the time this function is reached, the eventNameDelimiter should be a byte and not an enum

Actually, unless we really want this to be settable on a per-event basis, this shouldn't be a parameter - you should just reference the property of the EventNameManager

gesiu · 2024-10-21T23:24:55Z

src/OpenTelemetry.Exporter.OneCollector/Internal/EventNameManager.cs

    private static readonly Regex EventNamespaceValidationRegex = new(@"^[A-Za-z](?:\.?[A-Za-z0-9]+?)*$", RegexOptions.Compiled);
    private static readonly Regex EventNameValidationRegex = new(@"^[A-Za-z][A-Za-z0-9]*$", RegexOptions.Compiled);

    private readonly string defaultEventNamespace;
    private readonly string defaultEventName;
+    private readonly EventNameDelimiter defaultEventNameDelimiter;


I think this should just be 'eventNameDelimiter'.
The 'defaultEventNamespace' and 'defaultEventName' properties are about the values for a default event, not the default values for an arbitrary event

That is - someone could call log(dataFields: foo) without passing an event name, and the event name would be the default event name. (pseudocode, something like that)

Kielek · 2024-10-22T04:35:48Z

@sagarvish1989, could you please sing EasyCLA?
This is hard requirement to merge anything to this repository.

github-actions · 2024-10-30T03:18:07Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions · 2024-11-07T03:17:59Z

Closed as inactive. Feel free to reopen if this PR is still being worked on.

sagarvish1989 · 2024-11-11T22:20:33Z

Trying to reopen the PR to make it active

…entName

github-actions · 2024-11-26T03:21:30Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions · 2024-12-03T03:25:26Z

Closed as inactive. Feel free to reopen if this PR is still being worked on.

sagarvish1989 · 2024-12-04T18:11:11Z

@sagarvish1989, could you please sing EasyCLA? This is hard requirement to merge anything to this repository.

@Kielek For CLA, after selecting Microsoft corporation, I see it only gives Jason Messer as option for CLA manager . I had submitted request at least a week back and it hasn't gotten approved. Any suggestions how can I expedite this process?

reyang · 2024-12-04T18:38:48Z

@sagarvish1989, could you please sing EasyCLA? This is hard requirement to merge anything to this repository.

@Kielek For CLA, after selecting Microsoft corporation, I see it only gives Jason Messer as option for CLA manager . I had submitted request at least a week back and it hasn't gotten approved. Any suggestions how can I expedite this process?

@sagarvish1989 This is a Microsoft internal thing which I don't think @Kielek would be able to help. Would you send an email to whoever the approver is, and cc me (search for Reiley Yang in Microsoft corpnet) - I might be able to help there.

abuhsayem · 2025-01-23T17:46:56Z

@reyang @CodeBlanch @gesiu
It would be great if anyone can reopen this PR as I don't see an option to do so. I was able to checkout this branch using Github CLI 'gh pr checkout 2232' and successfully built the project in VS Studio .Net, not sure if I have permissions to push changes to it. Brian assigned me to complete this PR as Sagar is on bonding leave.

reyang · 2025-01-23T17:53:11Z

@reyang @CodeBlanch @gesiu It would be great if anyone can reopen this PR as I don't see an option to do so. I was able to checkout this branch using Github CLI 'gh pr checkout 2232' and successfully built the project in VS Studio .Net, not sure if I have permissions to push changes to it. Brian assigned me to complete this PR as Sagar is on bonding leave.

I've reopened it for you. Thanks!

github-actions · 2025-02-05T03:17:22Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

Design review to allow underscore in event name

7d816f4

sagarvish1989 had a problem deploying to external October 21, 2024 22:54 — with GitHub Actions Failure

github-actions bot requested review from CodeBlanch and reyang October 21, 2024 22:54

github-actions bot added the comp:exporter.onecollector Things related to OpenTelemetry.Exporter.OneCollector label Oct 21, 2024

gesiu reviewed Oct 21, 2024

View reviewed changes

github-actions bot added the Stale label Oct 30, 2024

github-actions bot closed this Nov 7, 2024

Merge remote-tracking branch 'upstream/main' into AllowUnderscoreInEv…

444b078

…entName

CodeBlanch reopened this Nov 15, 2024

CodeBlanch had a problem deploying to external November 15, 2024 21:34 — with GitHub Actions Failure

github-actions bot removed the Stale label Nov 16, 2024

Tweaks.

316c6b7

CodeBlanch had a problem deploying to external November 16, 2024 06:03 — with GitHub Actions Failure

Merge remote-tracking branch 'upstream/main' into AllowUnderscoreInEv…

9e2f04a

…entName

CodeBlanch had a problem deploying to external November 18, 2024 21:01 — with GitHub Actions Failure

github-actions bot added the Stale label Nov 26, 2024

github-actions bot closed this Dec 3, 2024

reyang reopened this Jan 23, 2025

reyang requested a deployment to external January 23, 2025 17:52 — with GitHub Actions Waiting

github-actions bot removed the Stale label Jan 24, 2025

abuhsayem mentioned this pull request Jan 29, 2025

[OneCollector] Allow underscore in event name #2529

Merged

4 tasks

github-actions bot added the Stale label Feb 5, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Design review to allow underscore in event name #2232

Design review to allow underscore in event name #2232

sagarvish1989 commented Oct 21, 2024

linux-foundation-easycla bot commented Oct 21, 2024 •

edited

Loading

gesiu Oct 21, 2024

sagarvish1989 Oct 22, 2024

gesiu Oct 21, 2024

gesiu Oct 21, 2024

gesiu Oct 21, 2024 •

edited

Loading

sagarvish1989 Oct 22, 2024

gesiu Oct 21, 2024

gesiu Oct 21, 2024

Kielek commented Oct 22, 2024

github-actions bot commented Oct 30, 2024

github-actions bot commented Nov 7, 2024

sagarvish1989 commented Nov 11, 2024

github-actions bot commented Nov 26, 2024

github-actions bot commented Dec 3, 2024

sagarvish1989 commented Dec 4, 2024

reyang commented Dec 4, 2024

abuhsayem commented Jan 23, 2025

reyang commented Jan 23, 2025

github-actions bot commented Feb 5, 2025

Design review to allow underscore in event name #2232

Are you sure you want to change the base?

Design review to allow underscore in event name #2232

Conversation

sagarvish1989 commented Oct 21, 2024

Changes

Merge requirement checklist

linux-foundation-easycla bot commented Oct 21, 2024 • edited Loading

gesiu Oct 21, 2024

Choose a reason for hiding this comment

sagarvish1989 Oct 22, 2024

Choose a reason for hiding this comment

gesiu Oct 21, 2024

Choose a reason for hiding this comment

gesiu Oct 21, 2024

Choose a reason for hiding this comment

gesiu Oct 21, 2024 • edited Loading

Choose a reason for hiding this comment

sagarvish1989 Oct 22, 2024

Choose a reason for hiding this comment

gesiu Oct 21, 2024

Choose a reason for hiding this comment

gesiu Oct 21, 2024

Choose a reason for hiding this comment

Kielek commented Oct 22, 2024

github-actions bot commented Oct 30, 2024

github-actions bot commented Nov 7, 2024

sagarvish1989 commented Nov 11, 2024

github-actions bot commented Nov 26, 2024

github-actions bot commented Dec 3, 2024

sagarvish1989 commented Dec 4, 2024

reyang commented Dec 4, 2024

abuhsayem commented Jan 23, 2025

reyang commented Jan 23, 2025

github-actions bot commented Feb 5, 2025

linux-foundation-easycla bot commented Oct 21, 2024 •

edited

Loading

gesiu Oct 21, 2024 •

edited

Loading