Skip to Content (Press Enter)
Post Closed
2020-10-15 10-24-31
Miguel Seabra Melo
2826Views
27Comments
Solved
Tip: Auditing from inside Extensions
Discussion
OS Certified
Integration
Extension
Audit & Monitoring
How-to
It is possible to write Audits to the application log from within your extensions, much like it can be done from your eSpace.

To achieve this, Hub Edition provides you with the function Audit(), inside the GenericExtendedActions namespace of its runtime. Anywhere inside your C# Extension, when you want to log an audit simply add the line

GenericExtendedActions.Audit( AppInfo.GetAppInfo().OsContext, <Message>, <ModuleName> );


and provide it with a suitable Message and ModuleName. These parameters have the exact same meaning as the equivalent parameters in the Audit Built-in Action in Service Studio. Please refer to Service Studio’s help documentation if you need more information on how the Audit functionality works.

Regards,


Miguel
14
0
09 Feb 2005
Copy Link
2019-05-07 15-30-20
Pedro Miguel de Andrade Rodrigues
Solution

Thanks for making this information available, it is really useful. I would just like to add that the Audit method is deprecated. we should use the LogMessage method instead.


The updated version is:

GenericExtendedActions.LogMessage(AppInfo.GetAppInfo().OsContext, <Message>, <Module Name>);

See solution in context
6
0
29 Jun 2018
Copy Link
UserImage.jpg
Vasanth
Is it applicable to Java Version also ? 
0
0
12 Sep 2013
Copy Link
2020-03-05 15-52-45
André Vieira
Staff
Hi Vasanth,

It is surely possible. Make sure you include the package outsystems.hubedition.runtimeplatform.
After this all you need is the following:

GenericExtendedActions.audit(AppInfo.getAppInfo().getOsContext(), "Module", "Message")
And that's it.

Cheers.

3
0
13 Sep 2013
Copy Link
2016-04-21 20-09-55
J.
 
MVP
How do you log errors (which you may want to catch, but log in the error log)

0
0
18 Sep 2013
Copy Link
2020-03-05 15-52-45
André Vieira
Staff
The exceptions thrown inside extensions are already logged by the platform (although there's a cap to prevent the lgo from flooding)...
0
0
18 Sep 2013
Copy Link
2019-11-12 17-31-26
Justin James
 
MVP
Here's the answer you want, in C#. What it does is give you a "LogError" method that will send stuff to the ERROR LOG (not the audit log!) so that it ends up where you expect it to. That lets you handle errors inside a try/catch block, log the error the the log, and set an error message or otherwise gracefully handle the error... because I *hate* getting exceptions from Extensions, and therefore causing the transaction to be aborted... ugh.

Also, you'll note that my version handles the 2,000 character cap (just be careful what you feed this!) nicely, and just produces multiple log messages of 2,000 characters each.

At the top of your extension:

using OutSystems.HubEdition.RuntimePlatform.Log;

Then in your extension (replace "Mandrill" with the name of the extension!):
 

        private void LogError(WebException e)

        {

            var fullMessage = "MESSAGE: " + e.Message;

 

            using (var streamReader = new StreamReader(e.Response.GetResponseStream()))

            {

                fullMessage += "\nRESPONSE: " + streamReader.ReadToEnd();

            }

 

            fullMessage += "\nDATA:";

 

            foreach (var key in e.Data.Keys)

            {

                fullMessage += "\n" + key + ": " + e.Data[key];

            }

 

            LogError(fullMessage);

        }

 

        private void LogError(Exception e)

        {

            ErrorLog.StaticWrite(DateTime.Now, AppInfo.GetAppInfo().OsContext.Session.SessionID,

            AppInfo.GetAppInfo().eSpaceId, AppInfo.GetAppInfo().Tenant.Id,

            AppInfo.GetAppInfo().OsContext.Session.UserId, e.Message, e.ToString(), "Mandrill");

        }

 

        private void LogError(string message)

        {

            if (message.Length <= 2000)

            {

                ErrorLog.StaticWrite(DateTime.Now, AppInfo.GetAppInfo().OsContext.Session.SessionID,

                AppInfo.GetAppInfo().eSpaceId, AppInfo.GetAppInfo().Tenant.Id,

                AppInfo.GetAppInfo().OsContext.Session.UserId, message, "", "Mandrill");

            }

            else

            {

                for (var currentPosition = 0; currentPosition <= message.Length - 1; currentPosition += 2000)

                {

                    var endPosition = Math.Min(message.Length - currentPosition, currentPosition + 2000);

 

                    ErrorLog.StaticWrite(DateTime.Now, AppInfo.GetAppInfo().OsContext.Session.SessionID,

                        AppInfo.GetAppInfo().eSpaceId, AppInfo.GetAppInfo().Tenant.Id,

                        AppInfo.GetAppInfo().OsContext.Session.UserId, message.Substring(currentPosition, endPosition), "", "Mandrill");

                }

            }

        }

2
0
23 Sep 2013
Copy Link
UserImage.jpg
José Antunes
Justin James wrote:
Here's the answer you want, in C#. What it does is give you a "LogError" method that will send stuff to the ERROR LOG (not the audit log!) so that it ends up where you expect it to. That lets you handle errors inside a try/catch block, log the error the the log, and set an error message or otherwise gracefully handle the error... because I *hate* getting exceptions from Extensions, and therefore causing the transaction to be aborted... ugh.

Also, you'll note that my version handles the 2,000 character cap (just be careful what you feed this!) nicely, and just produces multiple log messages of 2,000 characters each.

At the top of your extension:

using OutSystems.HubEdition.RuntimePlatform.Log;

Then in your extension (replace "Mandrill" with the name of the extension!):
 

        private void LogError(WebException e)

        {

            var fullMessage = "MESSAGE: " + e.Message;

 

            using (var streamReader = new StreamReader(e.Response.GetResponseStream()))

            {

                fullMessage += "\nRESPONSE: " + streamReader.ReadToEnd();

            }

 

            fullMessage += "\nDATA:";

 

            foreach (var key in e.Data.Keys)

            {

                fullMessage += "\n" + key + ": " + e.Data[key];

            }

 

            LogError(fullMessage);

        }

 

        private void LogError(Exception e)

        {

            ErrorLog.StaticWrite(DateTime.Now, AppInfo.GetAppInfo().OsContext.Session.SessionID,

            AppInfo.GetAppInfo().eSpaceId, AppInfo.GetAppInfo().Tenant.Id,

            AppInfo.GetAppInfo().OsContext.Session.UserId, e.Message, e.ToString(), "Mandrill");

        }

 

        private void LogError(string message)

        {

            if (message.Length <= 2000)

            {

                ErrorLog.StaticWrite(DateTime.Now, AppInfo.GetAppInfo().OsContext.Session.SessionID,

                AppInfo.GetAppInfo().eSpaceId, AppInfo.GetAppInfo().Tenant.Id,

                AppInfo.GetAppInfo().OsContext.Session.UserId, message, "", "Mandrill");

            }

            else

            {

                for (var currentPosition = 0; currentPosition <= message.Length - 1; currentPosition += 2000)

                {

                    var endPosition = Math.Min(message.Length - currentPosition, currentPosition + 2000);

 

                    ErrorLog.StaticWrite(DateTime.Now, AppInfo.GetAppInfo().OsContext.Session.SessionID,

                        AppInfo.GetAppInfo().eSpaceId, AppInfo.GetAppInfo().Tenant.Id,

                        AppInfo.GetAppInfo().OsContext.Session.UserId, message.Substring(currentPosition, endPosition), "", "Mandrill");

                }

            }

        }

 

Hi Justin,

I'm trying to use your solution but I'm getting compiling error from Integration Studio, but in Visual Studio it builds correctly... If I comment your 3 methods it compiles...
I'm using Integration Studio 6.0.0.8 and Visual Studio 2008...

Any thoughts?

Thanks.
 
0
0
03 Oct 2013
Copy Link
2021-02-19 11-14-24
Sopheak Sam

Worked like a treat ! thanks

0
0
03 May 2021
Copy Link
2019-11-12 17-31-26
Justin James
 
MVP
Jose -

And what error are you getting?

J.Ja
0
0
03 Oct 2013
Copy Link
UserImage.jpg
José Antunes
Hi James,

I'm getting none:



Is there a file were Integration Studio writes the log?

Thx!
0
0
04 Oct 2013
Copy Link
2019-11-12 17-31-26
Justin James
 
MVP
Jose -

Ah, you've encountered one of the first issues I had with OutSystems! This dialog is VERY confusing.

Click on the *second from the bottom line* (the one that says ".NET Compilation" and "Compiler Error") and the error will be displayed at the bottom.

J.Ja
2
0
04 Oct 2013
Copy Link
UserImage.jpg
José Antunes
Hi Justin,

Thanks for the tip!

I had 2 errors:
1) I didn't have SDK installed;
2) The compiler complain about 'var', throwing error CS0246.

As my time was short to dig into the problem, just changed the implicit 'var' to explicit types...

Thx,
JA
0
0
06 Oct 2013
Copy Link
2019-11-12 17-31-26
Justin James
 
MVP
Jose -

Yes, that's another known Integration Studio problem... not a "bug", just an "aggravation".

You need to change Integration Studio's .NET options to use the 3.5 .NET compilation, by making the compiler options line look like this:

/nologo /verbosity:minimal /target:Rebuild /property:Configuration=Release /ToolsVersion:3.5

J.Ja
2
0
06 Oct 2013
Copy Link
UserImage.jpg
José Antunes
Hi Justin,

Indeed, I was using the IS' default (/nologo /verbosity:minimal /target:Rebuild /property:Configuration=Release).

Tomorrow, at the office, I'll test with the new settings.

Thanks again for the help,
JA
1
0
06 Oct 2013
Copy Link
2023-02-10 19-42-59
João Melo
 
MVP
And how about nowadays, folks?

How can I manipulate exceptions from inside an extension?
0
0
15 Sep 2015
Copy Link
2019-10-27 01-32-56
Caio Santana Magalhães
 
MVP
Just for the record, the Audit function changed slightly in the latest version of ServiceStudio.

Here's the updated version:

GenericExtendedActions.Audit(AppInfo.GetAppInfo().OsContext, "Module", "Message");
1
0
27 Jan 2016
Copy Link
2019-05-07 15-30-20
Pedro Miguel de Andrade Rodrigues
Solution

Thanks for making this information available, it is really useful. I would just like to add that the Audit method is deprecated. we should use the LogMessage method instead.


The updated version is:

GenericExtendedActions.LogMessage(AppInfo.GetAppInfo().OsContext, <Message>, <Module Name>);

6
0
29 Jun 2018
Copy Link
UserImage.jpg
Sienna

Excuse my ignorance but I'm still finding my way in Outsystems, where do you find the error logs as they're not appearing in Service Center?

0
0
07 Mar 2019
Copy Link
2019-11-12 17-31-26
Justin James
 
MVP

Sienna wrote:

Excuse my ignorance but I'm still finding my way in Outsystems, where do you find the error logs as they're not appearing in Service Center?

This doesn't log to "errors" it logs to "general".

J.Ja


1
0
07 Mar 2019
Copy Link
UserImage.jpg
Sienna

Apologies for the delay in replying, I was busy working on other things.

I still can't see anything under Monitoring>General either.  I have added your code and...

GenericExtendedActions.LogMessage(AppInfo.GetAppInfo().OsContext, "MyTestComment", "MyVoidName");

What am I missing?

0
0
11 Mar 2019
Copy Link
UserImage.jpg
Sienna

Ok cancel that, it has now mysteriously appeared and I've no idea why but not going to complain lol.

0
0
11 Mar 2019
Copy Link
2018-12-09 19-13-19
Tiago Gomes

Is this still working? I can't see anything on General Tab.

0
0
20 Mar 2019
Copy Link
UserImage.jpg
Sienna

It works for me currently. Have you implemented the necessary code above in your solution?

0
0
20 Mar 2019
Copy Link
2018-12-09 19-13-19
Tiago Gomes

Using this code:

GenericExtendedActions.LogMessage(AppInfo.GetAppInfo().OsContext, "MyTestComment", "MyVoidName");

For me, nothing appears on General Tab...

0
0
20 Mar 2019
Copy Link
UserImage.jpg
Sienna

Try adding these as well....


        private void LogError(WebException e)
        {
            var fullMessage = "MESSAGE: " + e.Message;
            using (var streamReader = new StreamReader(e.Response.GetResponseStream()))
            {
                fullMessage += "\nRESPONSE: " + streamReader.ReadToEnd();
            }
            fullMessage += "\nDATA:";
            foreach (var key in e.Data.Keys)
            {
                fullMessage += "\n" + key + ": " + e.Data[key];
            }
            LogError(fullMessage);
        }


        private void LogError(Exception e)
        {
            ErrorLog.StaticWrite(DateTime.Now, AppInfo.GetAppInfo().OsContext.Session.SessionID,
            AppInfo.GetAppInfo().eSpaceId, AppInfo.GetAppInfo().Tenant.Id,
            AppInfo.GetAppInfo().OsContext.Session.UserId, e.Message, e.ToString(), "AsposeWordIntegration");
        }


        private void LogError(string message)
        {
            if (message.Length <= 2000)
            {
                ErrorLog.StaticWrite(DateTime.Now, AppInfo.GetAppInfo().OsContext.Session.SessionID,
                AppInfo.GetAppInfo().eSpaceId, AppInfo.GetAppInfo().Tenant.Id,
                AppInfo.GetAppInfo().OsContext.Session.UserId, message, "", "AsposeWordIntegration");
            }
            else
            {
                for (var currentPosition = 0; currentPosition <= message.Length - 1; currentPosition += 2000)
                {
                    var endPosition = Math.Min(message.Length - currentPosition, currentPosition + 2000);
                    ErrorLog.StaticWrite(DateTime.Now, AppInfo.GetAppInfo().OsContext.Session.SessionID,
                        AppInfo.GetAppInfo().eSpaceId, AppInfo.GetAppInfo().Tenant.Id,
                        AppInfo.GetAppInfo().OsContext.Session.UserId, message.Substring(currentPosition, endPosition), "", "AsposeWordIntegration");
                }
            }
        }

0
0
20 Mar 2019
Copy Link
2025-07-02 19-21-41
Carla Ribeiro da Fonseca

So...

Now doing this:

GenericExtendedActions.LogMessage(AppInfo.GetAppInfo().OsContext, "Who you gonna call?", "Ghostbusters!");

crashes with this error:

Object reference not set to an instance of an object.

Awesome!

I'm on Version 10.0.1014.0 of the platform, if that helps.

0
0
24 Jan 2020
Copy Link
2020-09-15 13-07-23
Kilian Hekhuis
 
MVP

Hi Carlos,

Are you calling the Action in the Extension from a Module, or are you trying to use it in Visual Studio itself, in a test project of some sorts? The "Object reference" error is probably because GetAppInfo() returns a null object, which would be the case when you call it outside a Module.

0
0
24 Jan 2020
Copy Link
2025-07-02 19-21-41
Carla Ribeiro da Fonseca

I am, yes.

Luckily I managed to figure out what was wrong with the extension (pro tip: if you're calling a web service, make sure you use the correct endpoint ??) so I'm OK for now.

Also, I didn't even know you could use the OutSystems references outside of an extension. To be fair, these days creating extensions is mostly only needed for quirky stuff like ancient SOAP web services that don't really follow the standards, so I'm definitely not an expert at it.

0
0
27 Jan 2020
Copy Link
Post Closed