Question Is Analytics.CustomEvent supposed to work?

I've created a custom event called "funnel", with a parameter "funnelStep" of type string in the dashboard Event Manager and also have enabled it.

Code for sending the event is like so:

Code (CSharp):

1. var pars = new Dictionary<string, object>();
2.         pars["funnelStep"] = name;
3.  
4.         Analytics.CustomEvent("funnel", pars);

However, in my testing I just see standard events, no custom event... googling this reveals numerous similar complaints. However it is not clear to me if I should be using AnalyticsEvent.Custom instead since documentation hints at either.

 

Already debugged stepped through yesterday to verify the events were indeed being sent. Could have a look at actual network communication as the next step, but TBH I might switch to Firebase before then.

 

Ok, Analytics.CustomEvent does show up... in the legacy analytics view.

What steps do I need to take for it to show up in the beta view? Checking the obvious: I would assume I am using the beta since other information (including standard events) shows up on the Beta header in the dashboard. If there is a way to prove/disprove (e.g. by stating a required com.unity.analytics package version), let me know.

This kind of illustrates my ongoing headache. I specially looked for a beta API for custom events, but ended up routing to legacy analytics. I have no idea if there's any way to actually do custom events in the beta.

 

Thanks for the very detailed explanation SebT, it's more than I could have hoped for! At the very least my packages and calls are off it appears. Will fix, now it feels 100% certain what went wrong.

 

I'm trying to make these Custom Events as well as you described SebT, but I just can't see the Custom Events.
I installed the Authentication package, but using Unity.Services.Authentication gives an error.


I keep getting this in my Console. I can see Standard Events fine, but my custom event is not showing up.

 

Hi Randy.
The Authentication is not giving the error anymore today. Looks like I just had to restart Unity.
But it is still giving me the same console errors for the events not being uploaded.
They bring me to the UploadComplete function here in the Dispatcher.cs when I click on them. I'm not sure what JSON I'm supposed to go and check.

Code (CSharp):

1.  
2. public void Flush()
3.         {
4.             // There is still a request pending.
5.             if (m_Request != null)
6.             {
7.                 return;
8.             }
9.  
10.             FlushBufferToService();
11.         }
12.  
13.         void FlushBufferToService()
14.         {
15.             // Serialize it into a JSON Blob, then POST it to the Collect bulk URL.
16.             // 'Bulk Events' -> https://docs.deltadna.com/advanced-integration/rest-api/
17.  
18.             (string collectData, int sentTokens) = m_DataBuffer.Serialize();
19.  
20.             if (string.IsNullOrEmpty(collectData))
21.             {
22.                 return;
23.             }
24.  
25.             byte[] postBytes = Encoding.UTF8.GetBytes(collectData);
26.          
27.             UnityWebRequest request = new UnityWebRequest(CollectUrl, UnityWebRequest.kHttpVerbPOST);
28.             UploadHandlerRaw upload = new UploadHandlerRaw(postBytes);
29.             upload.contentType = "application/json";
30.             request.uploadHandler = upload;
31.  
32.             m_RequestSentTokens = sentTokens;
33.             m_Request = request.SendWebRequest();
34.             m_Request.completed += UploadComplete;
35.          
36.             #if UNITY_ANALYTICS_EVENT_LOGS
37.             Debug.Log("Uploading events...");
38.             #endif
39.         }
40.  
41. void UploadComplete(AsyncOperation _)
42.         {
43.             long code = m_Request.webRequest.responseCode;
44.  
45.             #if UNITY_ANALYTICS_EVENT_LOGS
46.             Debug.Assert(code == 204, "Incorrect response, check your JSON for errors.");
47.             #endif
48.  
49.             if (!m_Request.webRequest.isNetworkError && code == 204)
50.             {
51.                 #if UNITY_ANALYTICS_EVENT_LOGS
52.                 Debug.LogFormat("Events uploaded successfully!", code);
53.                 #endif
54.  
55.                 // Remove the sent tokens from the buffer because they were accepted
56.                 m_DataBuffer.RemoveSentTokens(m_RequestSentTokens);
57.  
58.                 // We have got the internet so the disk cache is no longer needed.
59.                 // If the internet fails again, we will flush the buffer from scratch at that time.
60.                 m_DataBuffer.ClearDiskCache();
61.             }
62.             else
63.             {
64.                 #if UNITY_ANALYTICS_EVENT_LOGS
65.                 if (m_Request.webRequest.isNetworkError)
66.                 {
67.                     Debug.Log("Events failed to upload (network error) -- will retry at next heartbeat.");
68.                 }
69.                 else
70.                 {
71.                     Debug.LogFormat("Events failed to upload (code {0}) -- will retry at next heartbeat.", code);
72.                 }
73.                 #endif
74.                 m_DataBuffer.FlushToDisk();
75.             }
76.  
77.             // Clear the request to allow another request to be sent.
78.             m_Request.webRequest.Dispose();
79.             m_Request = null;
80.         }

 

@LucianTheFak Do you have another JSON library in your project? Please share the code you are using to send the event.

 

I'm not sure, is there a way I can check if I have another one?
As for the code:

Code (CSharp):

1. async void Start() {
2.         await UnityServices.InitializeAsync();
3.         if (!AuthenticationService.Instance.IsSignedIn) {
4.             await AuthenticationService.Instance.SignInAnonymouslyAsync();
5.         }
6.     }
7.  
8.     public void OnPlayerDeath() {
9.         string difficultyMethod = "";
10.         switch (DifficultyManager.instance.difficultyMethod) {
11.             case 1:
12.                 difficultyMethod = "Predetermined";
13.                 break;
14.             case 2:
15.                 difficultyMethod = "Sandbox";
16.                 break;
17.             case 3:
18.                 difficultyMethod = "Dynamic";
19.                 break;
20.         }
21.         Dictionary<string, object> parameters = new Dictionary<string, object>()
22.         {
23.             { "difficultyMethod", difficultyMethod }
24.         };
25.         Events.CustomData("playerDeath", parameters);
26.         Events.Flush();
27.     }

I'm trying to send this playerDeath event when my player dies.

 

Please show a screenshot of the assets and packages in the Project view, and a screenshot of your Package Manager, we can check for a duplicate library. Have you checked that difficultyMethod is not null? You don't have a default case in your switch statement. Add the following just before your custom event call, the output will show in the Console window.

Debug.Log("difficultyMethod value = " + difficultyMethod.ToString());

 

difficultyMethod isn't null, it gets set to one of the 3 cases at the start of the game. It printed out just fine.

Project View:




Package Manager:


All the other packages in the project are mostly just models.

 

Yes, you've imported NewtsonSoft JSON. I might suggest testing your code in a new/empty project without it and compare. Are you actually using all these packages in your game? Generally you only import what you need.

 

To be honest, I'm not sure where that one came from. I can try it in a new project, but would it work if I just deleted NewtsonSoft from Packages?

 

You would want to make a full project backup before deleting components. Another package that you've imported may depend on it, but you can certainly try.

 

It seems the Version Control package was dependent on NewtsonSoft, but I'm not using Collaborate in this project. But I see that the Authentication package lists NewtsonSoft in its dependencies, so I don't know if I can remove it.

 

One way to find out! I have Authentication in my project too, but I don't see the NewtonSoft package separately like in your screenshot. Please follow my previous suggestion with a new project to confirm. Don't break your current project.

 

I just created a new project and some packages were automatically installed. NewtonSoft wasn't there.
I install the Analytics and Authentication packages, and then the NewtonSoft folder appears in the Packages.

It appears that the Authentication package puts it there, since it lists it under its dependencies.

 

I tried sending a custom event in the new project, without the NewtonSoft folder in the project and without Authentication, but it's the same deal.

 

Sorry for the confusion, yes I see Newtonsoft Json in my project view also, I was looking in Package Manager previously. What version of Unity are you using? And you've created and enabled this event and parameter on your dashboard? The previous version of Analytics allowed you to send any events and parameters, now you need to specify the format first on the dashboard, as Randy mentioned above.

 

I'm using Unity 2020.3.17f1.



The test event and the previous playerDeath event are both enabled and have one custom parameter assigned to them.
This is all under the default production environment, I didn't change anything about that.

 

Can you try without the Flush command? That's the only line different than my code. Edit: I just tried with Flush, no errors. Otherwise, I'm wondering if you might have a firewall or similar blocking the server endpoint. And you're not seeing these events on your dashboard?

 

I'm only seeing the standard events gameRunning, gameStarted and gameEnded in my EventBrowser.
If it might be a firewall or antivirus(in this case MalwareBytes), what should I exclude? Just Unity itself, or what's the server endpoint?

 

Can you turn off any firewall or antivirus for a short test? The endpoints would be *.unity.*:* and *.unity3d.*:* But it's interesting that your standard events are making it through.

 

@LucianTheFak Also, a Charles capture would be helpful to troubleshoot. For a one time test, you can install it (for free) and we can take a look at the response mentioned in the error. https://support.unity.com/hc/en-us/articles/115002917683-Using-Charles-Proxy-with-Unity You would install the root certificate from the Help/SSL Proxying... menu and reboot. Ensure to place the certificate on your system as described in the article. You don't need the iOS or Android sections.

 

Do I also need to download and import the CharlesProxyUpdated.package into the project or?
And after I install Charles, do I just press Start Recording in Charles and try sending the event again?

 

The unitypackage is only for Android, you don't need it. Start recording in Charles, then press Play in the Editor. Ensure to save the session as a .chls file. Are you on Mac or Windows?

 

I'm on Windows. I'm installing Charles now.

 

Got it. Ensure to enter the values for the SSL Proxying Settings dialog and move the Charles certificate to Trusted Root Certification Authorities as mentioned under "For PC - Windows 10" and REBOOT.

 

@LucianTheFak I should add, since it might contain private information, best to send me the .chls file in a private message here.

 

Alright, I rebooted, will try out this thing now.

 

I started a Conversation and uploaded the .chls file there. I think that's what you meant by private message, yeah? I'm new to actual forum posting.

 

@LucianTheFak Your Charles capture was flawless, thank you for providing! I found a JSON error in the event request, but it's not in your code, it looks like a possible bug at our end. I will let our engineering team know. sorry for the inconvenience. I'm not familiar with a possible workaround yet.

 

Alright, I'll leave it be for now and focus on other things until you might have a solution. Thank you for helping me nonetheless!