logtivity / readme.md

readme.md in Activity Logs, User Activity Tracking, Multisite Activity Log from Logtivity 1.20.1, at readme.md

429 lines 18.5 KB

Raw Download Zip

1	=== Activity Logs, Alert Notifications, User Activity Tracking from Logtivity ===
2
3	Contributors: logtivity, stevejburge
4	Tags: activity log, logging, event monitoring, user activity, easy digital downloads, edd, formidable, formidable pro
5	Requires at least: 4.7
6	Tested up to: 6.0
7	Stable tag: 1.20.1
8	Requires PHP: 7.0
9	License: GPLv2 or later
10	License URI: https://www.gnu.org/licenses/gpl-2.0.html
11
12	Logtivity is the best activity log and monitoring plugin for WordPress agencies. Keep an accurate activity log of everything happening on your WordPress site.
13
14	== Description ==
15
16	<strong>When you set up Logtivity to monitor your clients' sites, you can relax. We track everything that happens on the sites you maintain, and Logtivity also sends you alerts for important events!</strong>
17
18	Logtivity is a centralized platform for activity logs and alerts. You can install Logtivity’s plugin and then user our service to keep a close eye on everything that happens on your clients’ sites.
19
20	Your clients never have to know that you’re using Logtivity. You can either show a white label version of the activity logs, or you can hide Logtivity entirely.
21
22	### Activity Logs and Alerts for WordPress Agencies ###
23
24	[](https://logtivity.ioLogtivity](https://logtivity.io](https://logtivity.io) provides the best activity logs for WordPress agencies. You can record all the user activity on your clients' sites. Then you can use the activity log data to send notifications to email or Slack. Plus, you can easily search and export the information. And you can turn the activity log data into beautiful, useful charts.
25
26	If you have customers on your clients' WordPress site, you’ll find Logtivity to be invaluable. Because Logtivity records all the important activity, you can see real customer journeys across the WordPress sites. This can be incredibly helpful for customer support: the activity log will show exactly what a user has done on your site.
27
28	To get started, simply install the Logtivity plugin and then connect your site to [](https://logtivity.ioLogtivity](https://logtivity.io](https://logtivity.io). You’ll immediately start to see the results.
29
30	### Join Logtivity and Start Your Monitoring ###
31
32	> <strong>Logtivity is a SaaS service</strong><br />
33	> You will need to create a Logtivity account to store your activity logs and create alerts. <a href="https://app.logtivity.io/register" rel="friend" title="Logtivity">Click here to get started with Logtivity!</a>
34
35	Yes, Logtivity will keep a record of the activity on your clients' websites. However, that’s just where the magic begins. You can then use the data in Logtivity and do three additional things:
36
37	* Send alert notifications to Slack and email.
38	* Easily export activity log reports to CSV files, no matter how many logs you have.
39	* Create beautiful activity log charts to visualize the data.
40
41	Here’s an introduction to those three options, showing why Logtivity is the best activity log plugin for WordPress agencies:
42
43	### Send Email and Slack alerts for user activity
44
45	Once your sites are connected to Logtivity, you can set up unlimited alerts for any activity you want to know about as soon as it happens. You can send the alerts to your email inbox or Slack channels.
46
47	One Logtivity customer is an agency that employs various writers. So they’ve set up a series of Slack alerts that show when the writers log in. You can use this as a security alert, letting you know every time someone in the Author role logs in.
48
49	Another agency customer sends themselves an email every time a plugin or theme is updated. They only run Wordpress updates on Monday, but realized that some plugins will run their own auto-updates. Logtivity allows them to be constantly aware of all site changes.
50
51	Another WordPress agency sends themselves an alert every time a user is added to any of their 100+ sites! They manage a network of portfolio sites that should never have new users. It's important to them to instantly get an alert if a new user is ever created.
52
53	eCommerce sites can use Logtivity for convenient notifications and set up alerts for all new, changed, and canceled subscriptions.
54
55	[](https://logtivity.io/docs/notifications/Click here to see more about alerts](https://logtivity.io/docs/notifications/](https://logtivity.io/docs/notifications/).
56
57	### Export user activity logs to CSV
58
59	Logtivity was started because one of our clients had reporting problems due to the amount of data collected on their site. The client was using a plugin that stored data in the WordPress database. Whenever we tried to export large amounts of logs, the site would show 502 errors. We needed to have the information stored separately. Being a dedicated service, Logtivity can optimize for things such as exporting very large numbers of activity logs.
60
61	[](https://logtivity.io/docs/export-data/Click here to see more about activity log exports](https://logtivity.io/docs/export-data/](https://logtivity.io/docs/export-data/).
62
63	### Create beautiful charts from your activity log
64
65	The banner on this WordPress.org plugin page shows you what's possible with Logtivity charts. First, I searched my site’s data for file downloads and then clicked the “Convert to Report” button. Logtivity did the rest. With a couple of mouse clicks, I’ve created a chart showing all the daily file downloads.
66
67	Logtivity customers can build a whole dashboard full of charts, so you can quickly see the number of logins, downloads, payments and anything else that's important to you.
68
69	[](https://logtivity.io/docs/reports/Click here to see more about activity log charts](https://logtivity.io/docs/reports/](https://logtivity.io/docs/reports/).
70
71	### What user activities does Logtivity record?
72
73	Logtivity records all core WordPress actions. In addition to support for the WordPress core, Logtivity records events for many plugins and themes.
74
75	[](https://logtivity.io/docs/what-logs/Click here to see more about what Logtivity records](https://logtivity.io/docs/what-logs/](https://logtivity.io/docs/what-logs/).
76
77	### Activity logs for WordPress user logins
78
79	It’s important to have an activity log on your WordPress site. You need user tracking because you need to know many people are visiting, making purchases, and logging in to your site. Yes, you can track visitors with Google Analytics, and you can track purchases with your payment gateway, but it’s harder to track WordPress-specific information such as log ins. Using Logtivity, you can get an overview of who is logging in to your site, and how many people are logging in every day.
80
81	If Logtivity is active on your site, you can go to the “Logs” screen and search for all the “User Logged in” events. You can use the search boxes to drill down for more specific user tracking information. For example, you can use the “Context” box to search for a particular user role. You can use this to search for all "Administrator" logins or all "Editor" logins.
82
83	You can also use the search option as a security log and look for nefarious patterns in the audit logs. For example, you can search by IP address to see if one person is using multiple logins. Or you can search by username to see if one account is being shared by different people.
84
85	[](https://logtivity.io/track-user-logins-wordpress/Click here to see more about activity logs for user logins](https://logtivity.io/track-user-logins-wordpress/](https://logtivity.io/track-user-logins-wordpress/).
86
87	== Screenshots ==
88
89	1. The best activity log for WordPress sites
90	2. See your clients' site logs inside WordPress
91	3. Get alerts for all key WordPress events
92	4. Create charts from your activity logs
93	5. Export large data files from your activity logs
94
95	== Installation ==
96	#### From your WordPress dashboard
97	Visit 'Plugins > Add New'
98	Search for 'logtivity’
99	Activate Logtivity from your Plugins page.
100
101	#### From WordPress.org
102	Download logtivity.
103	Upload the 'logtivity' directory to your '/wp-content/plugins/' directory, either through the UI (Plugins > Add new) or via SFTP or example.
104	Activate Logtivity from your Plugins page.
105
106	#### Once Activated
107	Visit 'Tools > Logtivity' to view the settings page.
108	Enter your Logtivity API key, configure your options and your event monitoring will start!
109
110	== Frequently Asked Questions ==
111
112	= What plugins do Logtivity activity logs support? =
113
114	Logtivity has some support for most WordPress plugins. If the plugin uses post types, we record when most post types are updated, created or deleted.
115
116	We currently have integrations with Easy Digital Downloads, Memberpress and Download Monitor. These integrations allow you to track things like Memberpress subscription creations, changes, or cancellations and also track when files are downloaded through Download Monitor.
117
118	We are working on more detailed event monitor support for some key plugins, including eCommerce plugins such as WooCommerce and Easy Digital Downloads.
119
120	Please contact us for specific details on any plugin that you are using.
121
122	= Can I log custom events? =
123
124	Yes, our user activity tracking plugin provides a flexible API to log and store custom events with Logtivity. An example of logging a custom event is below. This example is recording information from Stripe.com for a customer:
125
126	`
127	Logtivity::log()
128	->setAction('My Custom Action')
129	->addMeta('Meta Label', $meta)
130	->addMeta('Another Meta label', $someOtherMeta)
131	->addUserMeta('Stripe Customer ID', $stripeCustomerId)
132	->send();
133	`
134
135	[](https://logtivity.io/docs/custom-events/Click here to see more about custom activity logs](https://logtivity.io/docs/custom-events/](https://logtivity.io/docs/custom-events/).
136
137	= Is Logtivity a GDPR-compliant activity log? =
138
139	Yes, Logtivity gives you complete control over the user tracking information recorded in the audit logs. You can choose your GDPR settings. You can decide to only log a profile link, user ID, username, IP address, or nothing at all.
140
141	* Inside your WordPress site, go to “Tools” and then “Logtivity”.
142	* You can uncheck the boxes on this screen to stop Logtivity from recording personal user trackking data.
143
144	Here's an overview of the key GDPR-compliant settings:
145
146	* Store User ID: If you check this box, when logging an action, we will include the users User ID in the logged action.
147	* Store Users Profile Link: If you check this box, when logging an action, we will include the users profile link in the logged action.
148	* Store Users Username: If you check this box, when logging an action, we will include the users username in the logged action.
149	* Store Users IP Address: If you check this box, when logging an action, we will include the users IP address in the logged action.
150
151	[](https://logtivity.io/docs/personal-data/Click here for more about the GDPR and activity logs](https://logtivity.io/docs/personal-data/](https://logtivity.io/docs/personal-data/).
152
153	= Can I disable all activity logs and only store custom logs? =
154
155	Yes! You can easily disable all event monitoring that this plugin provides so that you can only store the user tracking audit logs that matter to you manually. You can also disable built in logs on an individual basis via the filter example below:
156
157	`
158	add_action('wp_logtivity_instance', function($Logtivity_Logger) {
159
160	if (strpos($Logtivity_Logger->action, 'Page was updated') !== false) {
161	$Logtivity_Logger->stop();
162	}
163
164	});
165	`
166	[](https://logtivity.io/docs/select-events/Click here for more about disabling activity logs](https://logtivity.io/docs/select-events/](https://logtivity.io/docs/select-events/).
167
168	= Can I rename the activity logs? =
169
170	Yes, it is possible to rename the events that are stored in Logtivity’s audit logs. For example, you can add this code to your site’s functions.php file. This code will result in an event “File Downloaded” being logged as “Resource Downloaded”.
171
172	`
173	add_action('wp_logtivity_instance', function($Logtivity_Logger) {
174	if (strpos($Logtivity_Logger->action, 'File Downloaded') !== false) {
175	$Logtivity_Logger->setAction('Resource Downloaded');
176	}
177	});
178	`
179	[](https://logtivity.io/docs/rename-events/Click here for more about renaming activity logs](https://logtivity.io/docs/rename-events/](https://logtivity.io/docs/rename-events/).
180
181	= Can I export the activity logs? =
182
183	Yes, Logtivity makes it easy to export your user activity data into a CSV file. Follow these steps for your audit log export:
184
185	* To get started, visit the “Logs” area inside [](https://app.logtivity.iohttps://app.logtivity.io](https://app.logtivity.io](https://app.logtivity.io).
186	* You can either search for a specific result, or you can use export all your event monitoring logs.
187	* When you see the logs you want to export, click “Actions” and then “Export to CSV”.
188	* Logtivity will show you the following message: “Export scheduled”.
189	* When the export file is ready, Logtivity will send you an email with a download link to the CSV file.
190
191	[](https://logtivity.io/docs/export-data/Click here to see more about exporting activity logs](https://logtivity.io/docs/export-data/](https://logtivity.io/docs/export-data/).
192
193	= Can I send activity log notifications to Slack channels? =
194
195	Yes, You can use Logtivity to send alerts to your Slack account. Follow these steps to connect Logtivity to a channel in your Slack account:
196
197	* In the Logtivity app, click on the name of your team.
198	* Click "Alert Channels".
199	* Check the "Slack" box.
200	* Enter the name of your Slack channel.
201	* Click the "Add Channel" button.
202	* You will now see a screen where Slack asks you to allow Logtivity access. Click the "Allow" button.
203	* You will be redirected back to the Logtivity app.
204	* Any alert for this Logtivity team will now be sent to your Slack account.
205
206	[](https://logtivity.io/docs/slack/Click here to see more about activity logs and Slack notifications](https://logtivity.io/docs/slack/](https://logtivity.io/docs/slack/).
207
208	= How does Logitivity compare to other activity log plugins? =
209
210	There are some good WordPress activity log plugins including WP Activity Log, WP User Activity, User Activity Log, Activity Log, WP Cerber, Jetpack activity log, User Activity Tracking and Log, WP Stream, Simple History, Aryo Activity Log and more.
211
212	Logtivity is different from those plugins in several important ways:
213
214	* It is a hosted service, so you don't have to store all the data in your site's database. This can really slow down your site! Logtivity allows you to store much more data, and export it more easily.
215	* Deeper integration with key plugins such as Easy Digital Downloads and MemberPress.
216	* Visualize your data with Logtivity's charts.
217
218	= Logitivity branding information =
219
220	Logtivity is the official brandname. When writing about this activity plugin, please make sure to uppercase the L:
221
222	* Logtivity (correct)
223	* logtivity (incorrect)
224	* Logtivity.io (incorrect)
225	* Log tivity, loggtivity, logg tivity (all incorrect)
226
227	== Changelog ==
228
229	= 1.20.1 =
230
231	_Release Date – Friday 17th June 2022_
232
233	* Fix minor layout issue in log modal.
234	* Disable some unuseful Option Updated logs.
235
236	= 1.20.0 =
237
238	_Release Date – Friday 17th June 2022_
239
240	* Add integration with Code Snippets plugin.
241
242	= 1.19.0 =
243
244	_Release Date – Thursday 16th June 2022_
245
246	* Start logging after plugins_loaded hook to ensure everything has loaded first.
247
248	= 1.18.0 =
249
250	_Release Date – Monday 13th June 2022_
251
252	* Add logging of Option Updates.
253	* Allow wildcards when disabling specific logs.
254
255	= 1.17.1 =
256
257	_Release Date – Saturday 4th June 2022_
258
259	* Fix occasional User Logged Out logging unnecessarily.
260	* Hide latest response info when debug mode is off.
261
262	= 1.17.0 =
263
264	_Release Date – Friday 13th May 2022_
265
266	* Added ability to globally disable logs across all sites from the Logtivity dashboard.
267	* Added ability to white label the Logtivity plugin across all sites from the Logtivity dashboard.
268
269	= 1.16.0 =
270
271	_Release Date – Monday 2nd May 2022_
272
273	* Add support for WP All Import
274
275	= 1.15.0 =
276
277	_Release Date – Tuesday 19th April 2022_
278
279	* Add ability for admins to disable individual actions from being logged.
280
281	= 1.14.0 =
282
283	_Release Date – Sunday 10th April 2022_
284
285	* Add logging of post meta changes.
286
287	= 1.13.0 =
288
289	_Release Date – Saturday 26th March 2022_
290
291	* Add logging of Term Created and Deleted.
292
293	= 1.12.0 =
294
295	_Release Date – Thursday 24th March 2022_
296
297	* Fix unexpected ) error on old vesions of php.
298	* Add logging of Term Updated.
299
300	= 1.11.1 =
301
302	_Release Date – Sunday 20th February 2022_
303
304	* Fix md5 hash of site_url relative to previous release of detecting url change.
305
306	= 1.11.0 =
307
308	_Release Date – Sunday 20th February 2022_
309
310	* Disable logging if site_url changes and show notice to admin to stop accidental logs coming from dev/staging environments.
311
312	= 1.10.0 =
313
314	_Release Date – Monday 14th February 2022_
315
316	* Add ability to register site with Logtivity from within the plugin by running a code snippet.
317
318	= 1.9.2 =
319
320	_Release Date – Sunday 23rd January 2022_
321
322	* Allow the Logtivity config to be set via filters.
323
324	= 1.9.1 =
325
326	_Release Date – Wednesday 22nd December 2021_
327
328	* Fix bug where logs weren't displaying when Logtivity debug mode was set to false.
329
330	= 1.9.0 =
331
332	_Release Date – Wednesday 22nd December 2021_
333
334	* Moved settings page to top level menu item to allow for sub menu.
335	* Added new logs page in wp-admin to allow viewing logs inside WordPress.
336
337	= 1.8.2 =
338
339	_Release Date – Thursday 10th December 2021_
340
341	* Fix unnecessary encoding of hyphens being passed to the context field in the API.
342
343	= 1.8.1 =
344
345	_Release Date – Thursday 9th December 2021_
346
347	* Fix conflict between Logtivity and Jetpack Widget Visibility where updating widget visibility in the customiser would fail.
348
349	= 1.8.0 =
350
351	_Release Date – Wednesday 8th December 2021_
352
353	* Added Formidable Pro integration.
354	* Added CSS tweaks to Logtivity Settings page.
355
356	= 1.7.1 =
357
358	_Release Date – Sunday 7th November 2021_
359
360	* Change action that Logout log hooks into to ensure user_id is attached to log.
361
362	= 1.7.0 =
363
364	_Release Date – Wednesday 17th August 2021_
365
366	* Improvements to Settings page.
367	* Log EDD License Renewed
368	* Log EDD License Renewal Notification Unsubscribed
369	* Log EDD License Status Changed to [new_status]
370	* Log EDD License Upgraded
371	* Log EDD Site Deactivated
372	* Log EDD Site Added
373	* Log EDD Subscription Renewed
374	* Log EDD Subscription Created
375	* Log EDD Subscription Updated
376	* Log EDD Subscription [status] eg. Expired, Cancelled etc.
377	* Log EDD Subscription Deleted
378	* Log EDD Payment Method Updated
379
380	= 1.6.1 =
381
382	_Release Date – Wednesday 4th August 2021_
383
384	* Begin adding support for the Easy Digital Downloads Software Licensing Addon.
385	* Log License Created events.
386	* Log License Activated events.
387	* Log License Activation Failed events.
388	* Log License Deactivated events.
389	* Don't log new comments when they are marked as spam.
390
391	= 1.6.0 =
392	* Added initial Easy Digital Downloads core integration.
393	* Track when Core Settings are updated.
394	* Track when Permalinks are updated.
395	* Track when Memberpress Transactions are Created/Updated.
396	* Track when Memberpress Emails are sent.
397	* Track when a Memberpress User Profile is updated.
398	* Track when Memberpress Settings are Updated.
399	* Track WordPress comments CRUD.
400
401	= 1.5.0 =
402	* Renamed Download Monitor Action name to File Downloaded.
403	* Added Request URL as log meta.
404	* Added Request Type as log meta.
405
406	= 1.4.0 =
407	* Removed deprecated async method from Logtivity_Logger class.
408	* Added API key verification when updating Logtivity settings.
409
410	= 1.3.1 =
411	* Fix user info not always being picked up on User login action.
412	* Fix 0 being logged for username when not logged in.
413	* Fixed duplicate logs being recorded when Updating a post in Gutenberg.
414
415	= 1.3.0 =
416	* Added revision link to Post Updated logs.
417	* Added Role to Content parameter for User Logged In and User Logged Out.
418
419	= 1.2.0 =
420	* Added context parameter to API calls to separate out Actions from Titles.
421
422	= 1.1.0 =
423	* Add logging when updating menus.
424	* Add logging when updating widgets.
425	* Fix spelling mistake in postPermanentlyDeleted method.
426
427	= 1.0 =
428	* Fix php warning when tracking a logout event.
429