logtivity / readme.txt

readme.txt in Activity Logs, User Activity Tracking, Multisite Activity Log from Logtivity 1.11.0, at readme.txt

404 lines 17.9 KB

Raw Download Zip

1	=== Activity Log - Monitor All WordPress Activities With 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: 5.8
7	Stable tag: 1.11.0
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 plugin for WordPress. Keep an accurate activity log of everything happening on your WordPress site.
13
14	== Description ==
15
16	<strong>Logtivity is an activity log that helps you understand exactly what’s happening on your WordPress site.</strong><br />
17
18	[Logtivity](https://logtivity.io) is the best activity log for WordPress. You can record all the user activity on your site. Then you can turn the activity log data into beautiful, useful charts. You can also use the activity log data to send notifications to email or Slack. Plus, you can easily search and export the information.
19
20	If you have customers on your WordPress site, you’ll find Logtivity to be invaluable. Because Logtivity records all the important activity, you can see real customer journeys across your WordPress site. This can be incredibly helpful for customer support: the activity log will show exactly what a user has done on your site.
21
22	To get started, simply install the Logtivity plugin and then connect your site to [Logtivity](https://logtivity.io). You’ll immediately start to see the results. You will see everything this user has done from installing plugins and updating posts, to changing blocks and plugin settings.
23
24	### Join Logtivity and Start Your Activity Log ###
25
26	> <strong>Logtivity is a SaaS service</strong><br />
27	> You will need to create a Logtivity account to store your activity logs. <a href="https://app.logtivity.io/register" rel="friend" title="Logtivity">Click here to get started with Logtivity!</a>
28
29	Yes, Logtivity will keep a record of the activity on your website. However, that’s just where the magic begins. You can then use your data in Logtivity and do three additional things:
30
31	* Create beautiful activity log charts to visualize your data.
32	* Send alert notifications to Slack and email.
33	* Easily export activity log reports to CSV files, no matter how many logs you have.
34
35	Here’s an introduction to those three options, showing why Logtivity is the best activity log plugin for WordPress:
36
37	### Create beautiful charts from your activity log
38
39	The image on the top of this page shows what's possible with Logtivity. 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.
40
41	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.
42
43	[Click here to see more about activity log charts](https://logtivity.io/docs/reports/).
44
45	### Send Email and Slack notifications for user activity
46
47	Once your site is 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 inbox or Slack channel.
48
49	One Logtivity customer 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 Administrator role logs in.
50
51	Another customer sends themselves an email every time a plugin or theme is updated. They only run 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. A third customer sends themselves an alert every time there have been no plugin updates in the last week! They want to make sure they don’t forget to run updates.
52
53	eCommerce sites can use Logtivity for convenient notifications and set up alerts for all new, changed, and canceled subscriptions. Click here to see more about alerts.
54
55	[Click here to see more about activity log 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 100,000 logs.
60
61	[Click here to see more about activity log exports](https://logtivity.io/docs/export-data/).
62
63	### What user activities does Logtivity record?
64
65	Below is a list of all core WordPress actions that Logtivity records for your site. In addition to support for the WordPress core, Logtivity records events for many plugins and themes.
66
67	* WordPress Core Updated
68	* WordPress Core Installed
69	* Post Updated
70	* Post Published
71	* Post Trashed
72	* Post Restored from Trash
73	* Post Permanently Deleted
74	* Attachment Uploaded
75	* Attachment Meta Updated
76	* Theme Switched
77	* Theme Deleted
78	* Theme Updated
79	* Theme Installed
80	* Theme File Edited
81	* Theme Customizer Updated
82	* User Logged In
83	* User Logged Out
84	* User Created
85	* User Deleted
86	* Profile Updated
87	* Plugin Activated
88	* Plugin Deactivated
89	* Plugin Deleted
90	* Plugin Updated
91	* Plugin Installed
92	* Plugin File Edited
93
94	### Easy Digital Downloads activity logs
95
96	Logtivity has detailed activity log support for the Easy Digital Downloads plugin and some extensions. Easy Digital Downloads is one of the best and most popular ways to sell digital products with WordPress. The activity logs, reports, and notifications provided by Logtivity will be helpful for anyone selling with Easy Digital Downloads.
97
98	Inside Logtivity, you will find support for the main Easy Digital Downloads plugin, including these actions:
99
100	* File Downloaded
101	* Payment Completed
102	* Payment Refunded
103	* Customer Created
104	* Download Added to Cart
105	* Download Removed from Cart
106	* Discount Applied
107	* Discount Published
108	* Discount Trashed
109	* Discount Updated
110
111	There’s also support for the Software Licensing extension and the the Recurring Payments extension:
112
113	* License Created
114	* License Activated
115	* License Activation Failed
116	* License Deactivated
117	* License Renewed
118	* License Renewal Notification Unsubscribed
119	* License Status Changed
120	* License Upgraded
121	* Site Deactivated
122	* Site Added
123	* Subscription Renewed
124	* Subscription Created
125	* Subscription Updated
126	* Subscription Status Changed
127	* Subscription Deleted
128	* Payment Method Updated
129
130	### Activity logs for WordPress user logins
131
132	It’s important to havee an activity log on your WordPress site. 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.
133
134	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 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.
135
136	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.
137
138	[Click here to see more about activity logs for user logins](ttps://logtivity.io/track-user-logins-wordpress/).
139
140	== Screenshots ==
141
142	1. Configurable Site Dashboard
143	2. Site Logs with powerful filtering
144	3. WordPress Settings Page
145	4. Set up unlimited alerts for any activity you want to know about as soon as it happens. Straight to your mailbox or slack channel.
146
147	== Installation ==
148	#### From your WordPress dashboard
149	Visit 'Plugins > Add New'
150	Search for 'logtivity’
151	Activate Logtivity from your Plugins page.
152
153	#### From WordPress.org
154	Download logtivity.
155	Upload the 'logtivity' directory to your '/wp-content/plugins/' directory, either through the UI (Plugins > Add new) or via SFTP or example.
156	Activate Logtivity from your Plugins page.
157
158	#### Once Activated
159	Visit 'Tools > Logtivity' to view the settings page.
160	Enter your Logtivity API key, configure your options and your event monitoring will start!
161
162	== Frequently Asked Questions ==
163
164	= What plugins do Logtivity activity logs support? =
165
166	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.
167
168	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.
169
170	We are working on more detailed event monitor support for some key plugins, including eCommerce plugins such as WooCommerce and Easy Digital Downloads.
171
172	Please contact us for specific details on any plugin that you are using.
173
174	= Can I log custom events? =
175
176	Yes, the 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:
177
178	`
179	Logtivity::log()
180	->setAction('My Custom Action')
181	->addMeta('Meta Label', $meta)
182	->addMeta('Another Meta label', $someOtherMeta)
183	->addUserMeta('Stripe Customer ID', $stripeCustomerId)
184	->send();
185	`
186
187	[Click here to see more about custom activity logs](https://logtivity.io/docs/custom-events/).
188
189	= Is Logtivity a GDPR-compliant activity log? =
190
191	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.
192
193	* Inside your WordPress site, go to “Tools” and then “Logtivity”.
194	* You can uncheck the boxes on this screen to stop Logtivity from recording personal user trackking data.
195
196	Here's an overview of the key GDPR-compliant settings:
197
198	* Store User ID: If you check this box, when logging an action, we will include the users User ID in the logged action.
199	* Store Users Profile Link: If you check this box, when logging an action, we will include the users profile link in the logged action.
200	* Store Users Username: If you check this box, when logging an action, we will include the users username in the logged action.
201	* Store Users IP Address: If you check this box, when logging an action, we will include the users IP address in the logged action.
202
203	[Click here for more about the GDPR and activity logs](https://logtivity.io/docs/personal-data/).
204
205	= Can I disable all activity logs and only store custom logs? =
206
207	Yes! You can easily disable all event monitoring that this plugin provides so that you can only store the audit logs that matter to you manually. You can also disable built in logs on an individual basis via the filter example below:
208
209	`
210	add_action('wp_logtivity_instance', function($Logtivity_Logger) {
211
212	if (strpos($Logtivity_Logger->action, 'Page was updated') !== false) {
213	$Logtivity_Logger->stop();
214	}
215
216	});
217	`
218	[Click here for more about disabling activity logs](https://logtivity.io/docs/select-events/).
219
220	= Can I rename the activity logs? =
221
222	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”.
223
224	`
225	add_action('wp_logtivity_instance', function($Logtivity_Logger) {
226	if (strpos($Logtivity_Logger->action, 'File Downloaded') !== false) {
227	$Logtivity_Logger->setAction('Resource Downloaded');
228	}
229	});
230	`
231	[Click here for more about renaming activity logs](https://logtivity.io/docs/rename-events/).
232
233	= Can I export the activity logs? =
234
235	Yes, Logtivity makes it easy to export your user activity data into a CSV file. Follow these steps for your audit log export:
236
237	* To get started, visit the “Logs” area inside [https://app.logtivity.io](https://app.logtivity.io).
238	* You can either search for a specific result, or you can use export all your event monitoring logs.
239	* When you see the logs you want to export, click “Actions” and then “Export to CSV”.
240	* Logtivity will show you the following message: “Export scheduled”.
241	* When the export file is ready, Logtivity will send you an email with a download link to the CSV file.
242
243	[Click here to see more about exporting activity logs](https://logtivity.io/docs/export-data/).
244
245	= Can I send activity log notifications to Slack channels? =
246
247	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:
248
249	* In the Logtivity app, click on the name of your team.
250	* Click "Alert Channels".
251	* Check the "Slack" box.
252	* Enter the name of your Slack channel.
253	* Click the "Add Channel" button.
254	* You will now see a screen where Slack asks you to allow Logtivity access. Click the "Allow" button.
255	* You will be redirected back to the Logtivity app.
256	* Any alert for this Logtivity team will now be sent to your Slack account.
257
258	[Click here to see more about activity logs and Slack notifications](https://logtivity.io/docs/slack/).
259
260	= How does Logitivity compare to other activity log plugins? =
261
262	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.
263
264	Logtivity is different from those plugins in several important ways:
265
266	* 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.
267	* Deeper integration with key plugins such as Easy Digital Downloads and MemberPress.
268	* Visualize your data with Logtivity's charts.
269
270	= Logitivity branding information =
271
272	Logtivity is the official brandname. When writing about this activity plugin, please make sure to uppercase the L:
273
274	* Logtivity (correct)
275	* logtivity (incorrect)
276	* Logtivity.io (incorrect)
277	* Log tivity, loggtivity, logg tivity (all incorrect)
278
279	== Changelog ==
280
281	= 1.11.0 =
282
283	_Release Date – Sunday 20th February 2022_
284
285	* Disable logging if site_url changes and show notice to admin to stop accidental logs coming from dev/staging environments.
286
287	= 1.10.0 =
288
289	_Release Date – Monday 14th February 2022_
290
291	* Add ability to register site with Logtivity from within the plugin by running a code snippet.
292
293	= 1.9.2 =
294
295	_Release Date – Sunday 23rd January 2022_
296
297	* Allow the Logtivity config to be set via filters.
298
299	= 1.9.1 =
300
301	_Release Date – Wednesday 22nd December 2021_
302
303	* Fix bug where logs weren't displaying when Logtivity debug mode was set to false.
304
305	= 1.9.0 =
306
307	_Release Date – Wednesday 22nd December 2021_
308
309	* Moved settings page to top level menu item to allow for sub menu.
310	* Added new logs page in wp-admin to allow viewing logs inside WordPress.
311
312	= 1.8.2 =
313
314	_Release Date – Thursday 10th December 2021_
315
316	* Fix unnecessary encoding of hyphens being passed to the context field in the API.
317
318	= 1.8.1 =
319
320	_Release Date – Thursday 9th December 2021_
321
322	* Fix conflict between Logtivity and Jetpack Widget Visibility where updating widget visibility in the customiser would fail.
323
324	= 1.8.0 =
325
326	_Release Date – Wednesday 8th December 2021_
327
328	* Added Formidable Pro integration.
329	* Added CSS tweaks to Logtivity Settings page.
330
331	= 1.7.1 =
332
333	_Release Date – Sunday 7th November 2021_
334
335	* Change action that Logout log hooks into to ensure user_id is attached to log.
336
337	= 1.7.0 =
338
339	_Release Date – Wednesday 17th August 2021_
340
341	* Improvements to Settings page.
342	* Log EDD License Renewed
343	* Log EDD License Renewal Notification Unsubscribed
344	* Log EDD License Status Changed to [new_status]
345	* Log EDD License Upgraded
346	* Log EDD Site Deactivated
347	* Log EDD Site Added
348	* Log EDD Subscription Renewed
349	* Log EDD Subscription Created
350	* Log EDD Subscription Updated
351	* Log EDD Subscription [status] eg. Expired, Cancelled etc.
352	* Log EDD Subscription Deleted
353	* Log EDD Payment Method Updated
354
355	= 1.6.1 =
356
357	_Release Date – Wednesday 4th August 2021_
358
359	* Begin adding support for the Easy Digital Downloads Software Licensing Addon.
360	* Log License Created events.
361	* Log License Activated events.
362	* Log License Activation Failed events.
363	* Log License Deactivated events.
364	* Don't log new comments when they are marked as spam.
365
366	= 1.6.0 =
367	* Added initial Easy Digital Downloads core integration.
368	* Track when Core Settings are updated.
369	* Track when Permalinks are updated.
370	* Track when Memberpress Transactions are Created/Updated.
371	* Track when Memberpress Emails are sent.
372	* Track when a Memberpress User Profile is updated.
373	* Track when Memberpress Settings are Updated.
374	* Track WordPress comments CRUD.
375
376	= 1.5.0 =
377	* Renamed Download Monitor Action name to File Downloaded.
378	* Added Request URL as log meta.
379	* Added Request Type as log meta.
380
381	= 1.4.0 =
382	* Removed deprecated async method from Logtivity_Logger class.
383	* Added API key verification when updating Logtivity settings.
384
385	= 1.3.1 =
386	* Fix user info not always being picked up on User login action.
387	* Fix 0 being logged for username when not logged in.
388	* Fixed duplicate logs being recorded when Updating a post in Gutenberg.
389
390	= 1.3.0 =
391	* Added revision link to Post Updated logs.
392	* Added Role to Content parameter for User Logged In and User Logged Out.
393
394	= 1.2.0 =
395	* Added context parameter to API calls to separate out Actions from Titles.
396
397	= 1.1.0 =
398	* Add logging when updating menus.
399	* Add logging when updating widgets.
400	* Fix spelling mistake in postPermanentlyDeleted method.
401
402	= 1.0 =
403	* Fix php warning when tracking a logout event.
404